summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBartosz Sosnowski <bartosz@janeasystems.com>2017-12-08 11:56:53 +0100
committerRuben Bridgewater <ruben@bridgewater.de>2018-02-17 15:24:38 +0100
commitea1a07656ee6dcbbde5de9f228ae075a9eeb6fad (patch)
tree1ff2643cf71fd385e157564138be0288cfda67ba /doc
parent33103e97587b3efa073d00752864210b43c5fc4a (diff)
downloadandroid-node-v8-ea1a07656ee6dcbbde5de9f228ae075a9eeb6fad.tar.gz
android-node-v8-ea1a07656ee6dcbbde5de9f228ae075a9eeb6fad.tar.bz2
android-node-v8-ea1a07656ee6dcbbde5de9f228ae075a9eeb6fad.zip
doc: mark accessing IPC channel fd as undefined
Adds note that accessing the fd of the IPC channel in any other way than process.send, or using the IPC channel with child processes that is not Node.js is not supported. PR-URL: https://github.com/nodejs/node/pull/17545 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/child_process.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
index 768eb91a83..80b74929b0 100644
--- a/doc/api/child_process.md
+++ b/doc/api/child_process.md
@@ -621,6 +621,10 @@ pipes between the parent and child. The value is one of the following:
will enable [`process.send()`][], [`process.disconnect()`][],
[`process.on('disconnect')`][], and [`process.on('message')`] within the
child.
+
+ Accessing the IPC channel fd in any way other than [`process.send()`][]
+ or using the IPC channel with a child process that is not a Node.js instance
+ is not supported.
3. `'ignore'` - Instructs Node.js to ignore the fd in the child. While Node.js
will always open fds 0 - 2 for the processes it spawns, setting the fd to
`'ignore'` will cause Node.js to open `/dev/null` and attach it to the