diff options
| author | Kevin Locke <kevin@kevinlocke.name> | 2016-02-19 00:26:26 +0300 |
|---|---|---|
| committer | Myles Borins <mborins@us.ibm.com> | 2016-02-23 01:13:14 +0300 |
| commit | 2043e6a63c37a7f52e9f250285995f514ce86763 (patch) | |
| tree | 27d87c982bbdd7dcedef1dbe50cfa962dd0aaa8e | |
| parent | 8c732ad1e1d336570d53cb79d0f6d70728ff1934 (diff) | |
doc: clarify child_process.execFile{,Sync} file arg
The changes to the file argument of execFile in #4504 make it appear
that execFile requires an absolute or relative path to the executable
file, when it also supports a filename which will be resolved using
$PATH. Although the example makes this clear, assuming there isn't a
node binary in $CWD, it's easy to overlook. This commit clarifies that
point.
It also updates the argument description for execFileSync to match,
since it was overlooked in #4504 and behaves identically.
PR-URL: https://github.com/nodejs/node/pull/5310
Reviewed-By: James M Snell <jasnell@gmail.com>
| -rw-r--r-- | doc/api/child_process.markdown | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown index 107145eacde..9ab3b2d3681 100644 --- a/doc/api/child_process.markdown +++ b/doc/api/child_process.markdown @@ -183,7 +183,7 @@ replace the existing process and uses a shell to execute the command.* ### child_process.execFile(file[, args][, options][, callback]) -* `file` {String} A path to an executable file +* `file` {String} The name or path of the executable file to run * `args` {Array} List of string arguments * `options` {Object} * `cwd` {String} Current working directory of the child process @@ -497,7 +497,7 @@ configuration at startup. ### child_process.execFileSync(file[, args][, options]) -* `file` {String} The filename of the program to run +* `file` {String} The name or path of the executable file to run * `args` {Array} List of string arguments * `options` {Object} * `cwd` {String} Current working directory of the child process |