Commit 6720aad20ce for nodejs
commit 6720aad20ce1e999f473390c47d51ff8ebeb220c
Author: Paul Bouchon <mail@bitpshr.net>
Date: Thu Nov 5 21:18:37 2026 -0500
doc: fix execFile/execFileSync shell option docs
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: https://github.com/nodejs/node/issues/32524
Signed-off-by: Paul Bouchon <mail@bitpshr.net>
PR-URL: https://github.com/nodejs/node/pull/64437
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
index 6ac072beedb..7f863c30665 100644
--- a/doc/api/child_process.md
+++ b/doc/api/child_process.md
@@ -379,7 +379,7 @@ changes:
normally be created on Windows systems. **Default:** `false`.
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
done on Windows. Ignored on Unix. **Default:** `false`.
- * `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
+ * `shell` {boolean|string} If `true`, runs `file` inside of a shell. Uses
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
shell can be specified as a string. See [Shell requirements][] and
[Default Windows shell][]. **Default:** `false` (no shell).
@@ -401,7 +401,7 @@ efficient than [`child_process.exec()`][].
> cancellation, externally propagated aborts, and timeouts. See
> [DEP0209](deprecations.md#dep0209-using-abortsignal-to-dispose-of-resources).
-The same options as [`child_process.exec()`][] are supported. Since a shell is
+The same options as [`child_process.exec()`][] are supported. If a shell is
not spawned, behaviors such as I/O redirection and file globbing are not
supported.
@@ -1203,7 +1203,7 @@ changes:
**Default:** `'buffer'`.
* `windowsHide` {boolean} Hide the subprocess console window that would
normally be created on Windows systems. **Default:** `false`.
- * `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
+ * `shell` {boolean|string} If `true`, runs `file` inside of a shell. Uses
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
shell can be specified as a string. See [Shell requirements][] and
[Default Windows shell][]. **Default:** `false` (no shell).