doc: 'ipc' is required with fork stdio option

Fixes: #8167 PR-URL: #8290 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
nodejs · Sep 9, 2016 · 48be8bc · 48be8bc
1 parent 5d43131
commit 48be8bc
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
@@ -263,6 +263,8 @@ added: v0.5.0
     [`stdio`][] for more details (Default: `false`)
   * `stdio` {Array} Supports the array version of [`child_process.spawn()`][]'s
     [`stdio`][] option. When this option is provided, it overrides `silent`.
+    The array must contain exactly one item with value `'ipc'` or an error will
+    be thrown. For instance `[0, 1, 2, 'ipc']`.
   * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
   * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
 * Return: {ChildProcess}