From 48be8bc4e1c20cf3272920a0fa41d8c8a654dbb4 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 26 Aug 2016 20:27:44 -0700 Subject: [PATCH] doc: `'ipc'` is required with fork stdio option Fixes: https://github.com/nodejs/node/issues/8167 PR-URL: https://github.com/nodejs/node/pull/8290 Reviewed-By: Colin Ihrig Reviewed-By: Benjamin Gruenbaum --- doc/api/child_process.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index a01b0db9b2..33027468ea 100644 --- 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}