From 2d2109240026523c75791a2795023ec2ad3024f1 Mon Sep 17 00:00:00 2001 From: Laurent Fortin <laurent.fortin@gmail.com> Date: Tue, 22 Sep 2015 15:01:23 -0400 Subject: [PATCH] doc: rearrange execSync and execFileSync MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changed the ordering so it is in line with the async methods. PR-URL: https://github.com/nodejs/node/pull/2940 Reviewed-By: Michaƫl Zasso <mic.besace@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> --- doc/api/child_process.markdown | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown index fdd9fce559cb4b..ab911acf22a5aa 100644 --- a/doc/api/child_process.markdown +++ b/doc/api/child_process.markdown @@ -704,10 +704,9 @@ until the process has completely exited. That is to say, if the process handles the `SIGTERM` signal and doesn't exit, your process will wait until the child process has exited. -### child_process.execFileSync(file[, args][, options]) +### child_process.execSync(command[, options]) -* `file` {String} The filename of the program to run -* `args` {Array} List of string arguments +* `command` {String} The command to run * `options` {Object} * `cwd` {String} Current working directory of the child process * `input` {String|Buffer} The value which will be passed as stdin to the spawned process @@ -725,7 +724,7 @@ process has exited. * `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') * return: {Buffer|String} The stdout from the command -`execFileSync` will not return until the child process has fully closed. When a +`execSync` will not return until the child process has fully closed. When a timeout has been encountered and `killSignal` is sent, the method won't return until the process has completely exited. That is to say, if the process handles the `SIGTERM` signal and doesn't exit, your process will wait until the child @@ -735,10 +734,10 @@ If the process times out, or has a non-zero exit code, this method ***will*** throw. The `Error` object will contain the entire result from [`child_process.spawnSync`](#child_process_child_process_spawnsync_command_args_options) +### child_process.execFileSync(file[, args][, options]) -### child_process.execSync(command[, options]) - -* `command` {String} The command to run +* `file` {String} The filename of the program to run +* `args` {Array} List of string arguments * `options` {Object} * `cwd` {String} Current working directory of the child process * `input` {String|Buffer} The value which will be passed as stdin to the spawned process @@ -756,7 +755,7 @@ throw. The `Error` object will contain the entire result from * `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') * return: {Buffer|String} The stdout from the command -`execSync` will not return until the child process has fully closed. When a +`execFileSync` will not return until the child process has fully closed. When a timeout has been encountered and `killSignal` is sent, the method won't return until the process has completely exited. That is to say, if the process handles the `SIGTERM` signal and doesn't exit, your process will wait until the child