Skip to content

Commit

Permalink
doc: add notes to child_process.fork() and .exec()
Browse files Browse the repository at this point in the history
Adds notes about the difference to their POSIX counterparts.

PR-URL: #1718
Fixes: #224
Reviewed-By: Roman Reiss <me@silverwind.io>
  • Loading branch information
Trott authored and silverwind committed May 20, 2015
1 parent 5773438 commit 86dd244
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/api/child_process.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -586,6 +586,8 @@ if it runs longer than `timeout` milliseconds. The child process is killed with
amount of data (in bytes) allowed on stdout or stderr - if this value is
exceeded then the child process is killed.

*Note: Unlike the `exec()` POSIX system call, `child_process.exec()` does not replace
the existing process and uses a shell to execute the command.*

### child_process.execFile(file[, args][, options][, callback])

Expand Down Expand Up @@ -645,6 +647,9 @@ done with care and by default will talk over the fd represented an
environmental variable `NODE_CHANNEL_FD` on the child process. The input and
output on this fd is expected to be line delimited JSON objects.

*Note: Unlike the `fork()` POSIX system call, `child_process.fork()` does not clone the
current process.*

## Synchronous Process Creation

These methods are **synchronous**, meaning they **WILL** block the event loop,
Expand Down

0 comments on commit 86dd244

Please sign in to comment.