Skip to content

Commit

Permalink
doc: add warning about Windows process groups
Browse files Browse the repository at this point in the history
This commit adds a warning for Windows platforms. `process.kill` wont
kill a process group on Windows and instead it throws an error.

Refs: #3617
PR-URL: #3681
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
r-52 authored and jasnell committed Nov 13, 2015
1 parent 3c56d5e commit 406c596
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/api/process.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 406c596

Please sign in to comment.