[Pkg-javascript-commits] [node-foreground-child] 40/69: add caveats re IPC and arbitrary FDs

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-foreground-child.

commit a4ae26d2f581bf6a3db548dd54985d2734588d54
Author: isaacs <i at izs.me>
Date:   Mon Jun 13 10:17:32 2016 -0700

    add caveats re IPC and arbitrary FDs
---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index c4314ea..1c45a1c 100644
--- a/README.md
+++ b/README.md
@@ -31,3 +31,16 @@ var child = foreground('cat', [__filename], function (done) {
   return done()
 })
 ```
+
+## Caveats
+
+The "normal" standard IO file descriptors (0, 1, and 2 for stdin,
+stdout, and stderr respectively) are shared with the child process.
+Additionally, if there is an IPC channel set up in the parent, then
+messages are proxied to the child on file descriptor 3.
+
+However, in Node, it's possible to also map arbitrary file descriptors
+into a child process.  In these cases, foreground-child will not map
+the file descriptors into the child.  If file descriptors 0, 1, or 2
+are used for the IPC channel, then strange behavior may happen (like
+printing IPC messages to stderr, for example).

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-foreground-child.git