docs: add missing shell option to execSync
authorfansworld-claudio <cr@fansworld.tv>
Mon, 19 Oct 2015 19:10:18 +0000 (16:10 -0300)
committerJames M Snell <jasnell@gmail.com>
Thu, 29 Oct 2015 15:38:41 +0000 (08:38 -0700)
Adds the "shell" option from child_process.exec to
child_process.execSync on the api docs.

Fixes: #3387
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/3440

doc/api/child_process.markdown

index bddf90f..13997d6 100644 (file)
@@ -716,6 +716,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)