Skip to content

Commit

Permalink
doc: clarify child_process.execFile{,Sync} file arg
Browse files Browse the repository at this point in the history
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: #5310
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
kevinoid authored and rvagg committed Feb 21, 2016
1 parent 5683efb commit 0389e38
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/api/child_process.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,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
Expand Down Expand Up @@ -502,7 +502,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
Expand Down

0 comments on commit 0389e38

Please sign in to comment.