doc: add note about child process line buffering
authorBen Noordhuis <info@bnoordhuis.nl>
Fri, 22 Feb 2013 00:19:39 +0000 (01:19 +0100)
committerBen Noordhuis <info@bnoordhuis.nl>
Fri, 22 Feb 2013 00:19:40 +0000 (01:19 +0100)
Fixes #4808.

doc/api/child_process.markdown

index 7c08424..913a376 100644 (file)
@@ -6,7 +6,9 @@ Node provides a tri-directional `popen(3)` facility through the
 `child_process` module.
 
 It is possible to stream data through a child's `stdin`, `stdout`, and
-`stderr` in a fully non-blocking way.
+`stderr` in a fully non-blocking way.  (Note that some programs use
+line-buffered I/O internally.  That doesn't affect node.js but it means
+data you send to the child process is not immediately consumed.)
 
 To create a child process use `require('child_process').spawn()` or
 `require('child_process').fork()`.  The semantics of each are slightly