doc: clarify child_process.execFile{,Sync} file argument #5310
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The changes to the file argument of execFile in nodejs#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 nodejs#4504 and behaves identically. Signed-off-by: Kevin Locke <[email protected]>
silverwind
added
child_process
|
LGTM |
1 similar comment
|
LGTM |
jasnell
pushed a commit
that referenced
this pull request
Feb 20, 2016
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]>
|
Landed in 91f6bc0 |
|
Great! Thanks @jasnell and @eljefedelrodeodeljefe! |
|
Thank you! |
rvagg
pushed a commit
that referenced
this pull request
Feb 21, 2016
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]>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 22, 2016
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]>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 22, 2016
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]>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 2, 2016
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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This may be a bit of a nit, but I thought it was worth fixing for clarity.
The changes to the
fileargument ofexecFilein #4504 make it appear thatexecFilerequires an absolute or relative path to the executable file, when in fact it also supports a filename which will be resolved using$PATH. Although the example clarifies this somewhat, assuming there isn't anodebinary in$CWD, it's easy to overlook. This commit clarifies that point.It also updates the argument description for
execFileSyncto match, since it was overlooked in #4504 and behaves identically.Thanks for considering,
Kevin