Skip to content

Commit e076d21

Browse files
authored
process: clarify Child::kill behavior (#7162)
1 parent 042433c commit e076d21

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

Diff for: tokio/src/process/mod.rs

+6-1
Original file line numberDiff line numberDiff line change
@@ -1164,7 +1164,12 @@ impl Child {
11641164

11651165
/// Forces the child to exit.
11661166
///
1167-
/// This is equivalent to sending a `SIGKILL` on unix platforms.
1167+
/// This is equivalent to sending a `SIGKILL` on unix platforms
1168+
/// followed by [`wait`](Child::wait).
1169+
///
1170+
/// Note: std version of [`Child::kill`](std::process::Child::kill) does not `wait`.
1171+
/// For an equivalent of `Child::kill` in the standard library,
1172+
/// use [`start_kill`](Child::start_kill).
11681173
///
11691174
/// # Examples
11701175
///

0 commit comments

Comments
 (0)