Clarify Child::kill behavior #7162
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maminrayej
added
T-docs
maminrayej
reviewed
Feb 17, 2025
tokio/src/process/mod.rs
Outdated
| @@ -1164,7 +1164,11 @@ impl Child { | |||
|
|
|||
| /// Forces the child to exit. | |||
| /// | |||
| /// This is equivalent to sending a `SIGKILL` on unix platforms. | |||
| /// This is equivalent to sending a `SIGKILL` on unix platforms followed by `wait`. | |||
There was a problem hiding this comment.
Please make wait a link for easier doc navigation.
tokio/src/process/mod.rs
Outdated
Comment on lines
1169
to
1171
| /// Note: behavior of this function is different from std version of | ||
| /// [`Child::kill`](std::process::Child::kill): std version does `wait`. | ||
| /// Tokio equivalent of std `Child::kill` is [`start_kill`](Child::start_kill). |
There was a problem hiding this comment.
nit: I think the phrasing could be a bit simplified. Like:
Note: The equivalent of `Child::kill` in the standard library is [`start_kill`](Child::start_kill).
There was a problem hiding this comment.
I cannot understabd your version (what side is what); rephrased.
``` Child::kill == std Child::kill + Child::wait Child::start_kill == std Child::kill ``` As a side note, kill that also waits, is convenient, but also dangerous, because `wait` may hang in certain cases (NFS, ptrace, etc). And different behavior between std and tokio may leads to bugs when code is mechanically converted from one to another. Better name name of this function might be `kill_and_wait`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a side note, kill that also waits, is convenient, but also
dangerous, because
waitmay hang in certain cases (NFS, ptrace,etc). And different behavior between std and tokio may leads to
bugs when code is mechanically converted from one to another. Better
name name of this function might be
kill_and_wait.CC @maminrayej