Skip to content

Commit 70c95ea

Browse files
r-52Myles Borins
authored and
Myles Borins
committed
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 <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent e6c2533 commit 70c95ea

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
@@ -547,7 +547,8 @@ string describing the signal to send. Signal names are strings like
547547
See [Signal Events][] and kill(2) for more information.
548548

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

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

0 commit comments

Comments
 (0)