Repository navigation
doc: fix execFile/execFileSync shell option docs - #64437
Merged
nodejs-github-bot merged 1 commit intoNov 6, 2026
Merged
Conversation
nodejs-github-bot
added
child_process
Contributor
Author
|
Hey @nodejs/documentation, just want to keep this on your radar. It's a small fix to the |
Member
|
This needs a rebase. |
The `shell` option for `execFile()` and `execFileSync()` was described as running `command` inside a shell, but those functions take a `file` argument, not `command`. The text was copied from `exec()`/`spawn()`. The note under `execFile()` also read "Since a shell is not spawned, behaviors such as I/O redirection and file globbing are not supported", which contradicts the preceding sentence that the same options as `exec()` (including `shell`) are supported. Change "Since" to "If" so it only applies when no shell is spawned. Fixes: nodejs#32524 Signed-off-by: Paul Bouchon <mail@bitpshr.net>
bitpshr
force-pushed
the
doc/child-process-execfile-shell
branch
from
August 24, 2026 12:35
cbf7ac9 to
df35988
Compare
Contributor
Author
|
@trivikr rebased and ready, thanks! |
trivikr
self-requested a review
August 24, 2026 17:50
Contributor
Author
|
Hi @nodejs/documentation, keeping this on your radar. Small doc fix, green since July, rebased and ready. Happy to rebase again if it has gone stale. |
trivikr
approved these changes
Nov 6, 2026
trivikr
added
author ready
Collaborator
|
Landed in 6720aad |
nodejs-github-bot
removed
the
commit-queue
aduh95
pushed a commit
that referenced
this pull request
Nov 11, 2026
The `shell` option for `execFile()` and `execFileSync()` was described as running `command` inside a shell, but those functions take a `file` argument, not `command`. The text was copied from `exec()`/`spawn()`. The note under `execFile()` also read "Since a shell is not spawned, behaviors such as I/O redirection and file globbing are not supported", which contradicts the preceding sentence that the same options as `exec()` (including `shell`) are supported. Change "Since" to "If" so it only applies when no shell is spawned. Fixes: #32524 Signed-off-by: Paul Bouchon <mail@bitpshr.net> PR-URL: #64437 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
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
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 fixes a few small inaccuracies in the
child_processdocs, all pointed out in #32524.The
shelloption forexecFile()andexecFileSync()says it runscommandinside a shell, but those functions take afileargument, notcommand. The wording was copied fromexec()/spawn(), wherecommandis correct.The note under
execFile()also reads "Since a shell is not spawned, behaviors such as I/O redirection and file globbing are not supported", which contradicts the line right before it saying the same options asexec()(includingshell) are supported. Changing "Since" to "If" makes it only apply when there's no shell.I left the exec-vs-execFile "difference" wording (also mentioned in the issue) alone, since it isn't wrong as written and looked more like a judgment call for a maintainer.