Commit 35a382e
doc: add Windows-specific info to subprocess.kill()
Clarify the inner workings of .kill on Windows,
since termination signals are not available there.
Fixes: #34858
PR-URL: #34867
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>1 parent 2e3305d commit 35a382e
1 file changed
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1203,6 +1203,11 @@ may not actually terminate the process. | |||
| 1203 | 1203 | ||
| 1204 | 1204 | See kill(2) for reference. | |
| 1205 | 1205 | ||
| 1206 | + On Windows, where POSIX signals do not exist, the `signal` argument will be | ||
| 1207 | + ignored, and the process will be killed forcefully and abruptly (similar to | ||
| 1208 | + `'SIGKILL'`). | ||
| 1209 | + See [Signal Events][] for more details. | ||
| 1210 | + | ||
| 1206 | 1211 | On Linux, child processes of child processes will not be terminated | |
| 1207 | 1212 | when attempting to kill their parent. This is likely to happen when running a | |
| 1208 | 1213 | new process in a shell or with the use of the `shell` option of `ChildProcess`: | |
@@ -1667,6 +1672,7 @@ or [`child_process.fork()`][]. | |||
| 1667 | 1672 | [Default Windows shell]: #child_process_default_windows_shell | |
| 1668 | 1673 | [HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm | |
| 1669 | 1674 | [Shell requirements]: #child_process_shell_requirements | |
| 1675 | + [Signal Events]: process.md#process_signal_events | ||
| 1670 | 1676 | [`'disconnect'`]: process.md#process_event_disconnect | |
| 1671 | 1677 | [`'error'`]: #child_process_event_error | |
| 1672 | 1678 | [`'exit'`]: #child_process_event_exit | |
0 commit comments