From 595320a55a75aee86f3bae892b1688be7a8d1eff Mon Sep 17 00:00:00 2001 From: Roman Klauke Date: Thu, 5 Nov 2015 20:08:34 +0100 Subject: [PATCH] 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 Reviewed-By: James M Snell --- doc/api/process.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/api/process.markdown b/doc/api/process.markdown index 444a4c703ccd3d..7e70a79151083e 100644 --- a/doc/api/process.markdown +++ b/doc/api/process.markdown @@ -547,7 +547,8 @@ string describing the signal to send. Signal names are strings like See [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