docs: add missing shell option to execSync

Adds the "shell" option from child_process.exec to child_process.execSync on the api docs. Fixes: #3387 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> PR-URL: #3440
nodejs · Oct 21, 2015 · 47b06f6 · 47b06f6
1 parent bbbd81e
commit 47b06f6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown
@@ -715,6 +715,10 @@ process has exited.
     - `stderr` by default will be output to the parent process' stderr unless
       `stdio` is specified
   * `env` {Object} Environment key-value pairs
+  * `shell` {String} Shell to execute the command with
+    (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should
+     understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,
+     command line parsing should be compatible with `cmd.exe`.)
   * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
   * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
   * `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)