From 0389e3803c17d5810f89d111373222a2e43f98e6 Mon Sep 17 00:00:00 2001 From: Kevin Locke Date: Thu, 18 Feb 2016 13:26:26 -0800 Subject: [PATCH] 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 --- doc/api/child_process.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown index 3096fbb641b14f..5b87a34d88a7e3 100644 --- a/doc/api/child_process.markdown +++ b/doc/api/child_process.markdown @@ -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 @@ -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