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

PR-URL: https://github.com/nodejs/node/pull/34867
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
João Lucas Lucchetta 2020-08-21 18:11:38 -03:00 committed by Myles Borins
parent 570fbcef93
commit 13c3924af8
No known key found for this signature in database
GPG Key ID: 933B01F40B5CA946

View File

@ -1277,6 +1277,11 @@ may not actually terminate the process.
See kill(2) for reference. See kill(2) for reference.
On Windows, where POSIX signals do not exist, the `signal` argument will be
ignored, and the process will be killed forcefully and abruptly (similar to
`'SIGKILL'`).
See [Signal Events][] for more details.
On Linux, child processes of child processes will not be terminated 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 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`: new process in a shell or with the use of the `shell` option of `ChildProcess`:
@ -1741,6 +1746,7 @@ or [`child_process.fork()`][].
[Default Windows shell]: #child_process_default_windows_shell [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 [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 [Shell requirements]: #child_process_shell_requirements
[Signal Events]: process.md#process_signal_events
[`'disconnect'`]: process.md#process_event_disconnect [`'disconnect'`]: process.md#process_event_disconnect
[`'error'`]: #child_process_event_error [`'error'`]: #child_process_event_error
[`'exit'`]: #child_process_event_exit [`'exit'`]: #child_process_event_exit