std: Child::kill() returns error if process has already exited by andreastt · Pull Request #49461 · rust-lang/rust

andreastt · 2018-03-28T18:01:08Z

This patch makes it clear in std::process::Child::kill()'s API
documentation that an error is returned if the child process has
already cleanly exited. This is implied by the example, but not
called out explicitly.

This patch makes it clear in std::process::Child::kill()'s API documentation that an error is returned if the child process has already cleanly exited. This is implied by the example, but not called out explicitly.

Mark-Simulacrum

Could we note which error is returned, at least on common platforms, though we should indicate it's not guaranteed to be the case.

andreastt · 2018-03-28T22:07:42Z

Certainly we could.

Helpfully, @whimboo provided an example of such an error in https://bugzilla.mozilla.org/show_bug.cgi?id=1448900#c3. I’ve referenced InvalidInput but I’m not sure how useful it is.

When you say it is not guaranteed that it returns an error if the process has already exited, which systems are you referring to?

Mark-Simulacrum · 2018-03-29T04:45:43Z

I meant that the error returned today on a given system might change down the road and/or other situations could return new errors; we can't guarantee stability of underlying OS APIs.

andreastt · 2018-03-29T09:43:19Z

And do you think the amendment resolves this issue? Specifically it s/is returned/might be returned/.

Mark-Simulacrum · 2018-03-29T14:00:23Z

I'd rather leave that as is returned and then have a note in a separate paragraph, somewhat like what we do here: https://doc.rust-lang.org/nightly/std/fs/struct.OpenOptions.html#errors (with the "The mapping to ErrorKinds is not part of the compatibility contract of the function, especially the Other kind might change to more specific kinds in the future." part).

andreastt · 2018-03-29T17:11:30Z

Thanks for your feedback. I’ve pushed another fixup which takes that into consideration. Let me know what you think.

shepmaster · 2018-03-30T19:07:47Z

r? @Mark-Simulacrum

Mark-Simulacrum

r=me with the nit fixed

Mark-Simulacrum · 2018-03-30T19:36:48Z

+ ///
+ /// [`ErrorKind`]: ../io/enum.ErrorKind.html
+ /// [`InvalidInput`]: ../io/enum.ErrorKind.html#variant.InvalidInput
+ /// [`Other]: ../io/enum.ErrorKind.html#variant.Other


Missing a '`' on Other

shepmaster · 2018-04-07T19:51:39Z

Ping from triage @andreastt — you have a review comment to address!

andreastt · 2018-04-08T15:20:56Z

Sorry about that; nit addressed.

emilyalbini · 2018-04-16T10:02:19Z

Ping from triage @Mark-Simulacrum! The user addressed your comments.

Mark-Simulacrum

r=me with the nit fixed

Mark-Simulacrum · 2018-04-16T23:52:47Z

 impl Child {
- /// Forces the child to exit. This is equivalent to sending a
- /// SIGKILL on unix platforms.
+ /// Forces the child process to exit. If the child has already exited, an [`InvalidInput`]


nit: Double space after the period.

emilyalbini · 2018-04-23T12:03:03Z

Ping from triage @Mark-Simulacrum! The user addressed your comments.

Mark-Simulacrum · 2018-04-23T13:37:18Z

@bors r+ rollup

bors · 2018-04-23T13:37:20Z

📌 Commit bc4bd56 has been approved by Mark-Simulacrum

…-Simulacrum std: Child::kill() returns error if process has already exited This patch makes it clear in std::process::Child::kill()'s API documentation that an error is returned if the child process has already cleanly exited. This is implied by the example, but not called out explicitly.

Rollup of 11 pull requests Successful merges: - #49461 (std: Child::kill() returns error if process has already exited) - #49727 (Add Cell::update) - #49812 (Fix revision support for UI tests.) - #49829 (Add doc links to `std::os` extension traits) - #49906 (Stabilize `std::hint::unreachable_unchecked`.) - #49970 (Deprecate Read::chars and char::decode_utf8) - #49985 (don't see issue #0) - #50118 (fix search bar bug) - #50139 (encourage descriptive issue titles) - #50174 (Use FxHashMap in syntax_pos::symbol::Interner::intern.) - #50185 (core: Fix overflow in `int::mod_euc` when `self < 0 && rhs == MIN`) Failed merges:

std: Child::kill() returns error if process has already exited
7eb9a09
This patch makes it clear in std::process::Child::kill()'s API documentation that an error is returned if the child process has already cleanly exited. This is implied by the example, but not called out explicitly.

Mark-Simulacrum reviewed Mar 28, 2018
View reviewed changes

fixup! std: Child::kill() returns error if process has already exited
d541282

fixup! std: Child::kill() returns error if process has already exited
51dc630

rust-highfive assigned Mark-Simulacrum Mar 30, 2018

shepmaster added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 30, 2018

Mark-Simulacrum reviewed Mar 30, 2018
View reviewed changes

shepmaster added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 7, 2018

fixup! std: Child::kill() returns error if process has already exited
fd2afa0

emilyalbini added T-libs-api [DEPRECATED; DO NOT USE] S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 16, 2018

Mark-Simulacrum reviewed Apr 16, 2018
View reviewed changes

fixup! std: Child::kill() returns error if process has already exited
bc4bd56

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 23, 2018

kennytm mentioned this pull request Apr 24, 2018
Rollup of 11 pull requests #50191
Merged

bors merged commit bc4bd56 into rust-lang:masterApr 24, 2018

Uh oh!

Uh oh!

Conversation

andreastt commented Mar 28, 2018

Uh oh!

Mark-Simulacrum left a comment

Choose a reason for hiding this comment

Uh oh!

andreastt commented Mar 28, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Mark-Simulacrum commented Mar 29, 2018

Uh oh!

andreastt commented Mar 29, 2018

Uh oh!

Mark-Simulacrum commented Mar 29, 2018

Uh oh!

andreastt commented Mar 29, 2018

Uh oh!

shepmaster commented Mar 30, 2018

Uh oh!

Mark-Simulacrum left a comment

Choose a reason for hiding this comment

Uh oh!

Mark-SimulacrumMar 30, 2018

Choose a reason for hiding this comment

Uh oh!

shepmaster commented Apr 7, 2018

Uh oh!

andreastt commented Apr 8, 2018

Uh oh!

emilyalbini commented Apr 16, 2018

Uh oh!

Mark-Simulacrum left a comment

Choose a reason for hiding this comment

Uh oh!

Mark-SimulacrumApr 16, 2018

Choose a reason for hiding this comment

Uh oh!

emilyalbini commented Apr 23, 2018

Uh oh!

Mark-Simulacrum commented Apr 23, 2018

Uh oh!

bors commented Apr 23, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

andreastt commented Mar 28, 2018•
edited
Loading