From c0ba12a74e083fb4884a1a292d02f238df7f0045 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Lucas=20Lucchetta?= Date: Fri, 21 Aug 2020 18:11:38 -0300 Subject: [PATCH] doc: add Windows-specific info to subprocess.kill() Clarify the inner workings of .kill on Windows, since termination signals are not available there. Fixes: https://github.com/nodejs/node/issues/34858 --- doc/api/child_process.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 6b092a83018d3c..72d25b173719a7 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -1211,6 +1211,10 @@ may not actually terminate the process. See kill(2) for reference. +On Windows, the child process is forcefully terminated because +`SIGKILL` and `SIGTERM` signals are not available. +See [Signal Events][] for more details. + On Linux, child processes of child processes will not be terminated when attempting to kill their parent. This is likely to happen when running a new process in a shell or with the use of the `shell` option of `ChildProcess`: @@ -1673,6 +1677,7 @@ or [`child_process.fork()`][]. [Default Windows shell]: #child_process_default_windows_shell [HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm [Shell requirements]: #child_process_shell_requirements +[Signal Events]: process.md#process_signal_events [`'disconnect'`]: process.md#process_event_disconnect [`'error'`]: #child_process_event_error [`'exit'`]: #child_process_event_exit