Skip to content

Commit 406c596

Browse files
r-52jasnell
authored andcommitted
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: #3617 PR-URL: #3681 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 3c56d5e commit 406c596

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/api/process.markdown

+2-1
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,8 @@ string describing the signal to send. Signal names are strings like
548548
See [Signal Events](#process_signal_events) and kill(2) for more information.
549549

550550
Will throw an error if target does not exist, and as a special case, a signal
551-
of `0` can be used to test for the existence of a process.
551+
of `0` can be used to test for the existence of a process. Windows platforms
552+
will throw an error if the `pid` is used to kill a process group.
552553

553554
Note that even though the name of this function is `process.kill`, it is really
554555
just a signal sender, like the `kill` system call. The signal sent may do

0 commit comments

Comments
 (0)