Browse Source

doc: add warning about Windows process groups

This commit adds a warning for Windows platforms. `process.kill` wont
kill a process group on Windows and instead it throws an error.

Refs: https://github.com/nodejs/node/issues/3617
PR-URL: https://github.com/nodejs/node/pull/3681
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
v5.x
Roman Klauke 9 years ago
committed by Jeremiah Senkpiel
parent
commit
d137f0fd28
  1. 3
      doc/api/process.markdown

3
doc/api/process.markdown

@ -548,7 +548,8 @@ string describing the signal to send. Signal names are strings like
See [Signal Events](#process_signal_events) and kill(2) for more information.
Will throw an error if target does not exist, and as a special case, a signal
of `0` can be used to test for the existence of a process.
of `0` can be used to test for the existence of a process. Windows platforms
will throw an error if the `pid` is used to kill a process group.
Note that even though the name of this function is `process.kill`, it is really
just a signal sender, like the `kill` system call. The signal sent may do

Loading…
Cancel
Save