ExitStatus: print "exit status: {}" rather than "exit code: {}" on unix #83462

ijackson · 2021-03-25T10:42:56Z

Proper Unix terminology is "exit status" (vs "wait status"). "exit
code" is imprecise on Unix and therefore unclear. (As far as I can
tell, "exit code" is correct terminology on Windows.)

This new wording is unfortunately inconsistent with the identifier
names in the Rust stdlib.

It is the identifier names that are wrong, as discussed at length in eg
https://doc.rust-lang.org/nightly/std/process/struct.ExitStatus.html
https://doc.rust-lang.org/nightly/std/os/unix/process/trait.ExitStatusExt.html

Unfortunately for API stability reasons it would be a lot of work, and
a lot of disruption, to change the names in the stdlib (eg to rename
std::process::ExitStatus to std::process::ChildStatus or
something), but we should fix the message output. Many (probably
most) readers of these messages about exit statuses will be users and
system administrators, not programmers, who won't even know that Rust
has this wrong terminology.

So I think the right thing is to fix the documentation (as I have
already done) and, now, the terminology in the implementation.

This is a user-visible change to the behaviour of all Rust programs
which run Unix subprocesses. Hopefully no-one is matching against the
exit status string, except perhaps in tests.

Proper Unix terminology is "exit status" (vs "wait status"). "exit code" is imprecise on Unix and therefore unclear. (As far as I can tell, "exit code" is correct terminology on Windows.) This new wording is unfortunately inconsistent with the identifier names in the Rust stdlib. It is the identifier names that are wrong, as discussed at length in eg https://doc.rust-lang.org/nightly/std/process/struct.ExitStatus.html https://doc.rust-lang.org/nightly/std/os/unix/process/trait.ExitStatusExt.html Unfortunately for API stability reasons it would be a lot of work, and a lot of disruption, to change the names in the stdlib (eg to rename `std::process::ExitStatus` to `std::process::ChildStatus` or something), but we should fix the message output. Many (probably most) readers of these messages about exit statuses will be users and system administrators, not programmers, who won't even know that Rust has this wrong terminology. So I think the right thing is to fix the documentation (as I have already done) and, now, the terminology in the implementation. This is a user-visible change to the behaviour of all Rust programs which run Unix subprocesses. Hopefully no-one is matching against the exit status string, except perhaps in tests. Signed-off-by: Ian Jackson <[email protected]>

rust-highfive · 2021-03-25T10:42:59Z

r? @sfackler

(rust-highfive has picked a reviewer for you, use r? to override)

joshtriplett · 2021-03-25T20:55:37Z

@bors r+ rollup

bors · 2021-03-25T20:55:39Z

📌 Commit 11e40ce has been approved by joshtriplett

…, r=joshtriplett ExitStatus: print "exit status: {}" rather than "exit code: {}" on unix Proper Unix terminology is "exit status" (vs "wait status"). "exit code" is imprecise on Unix and therefore unclear. (As far as I can tell, "exit code" is correct terminology on Windows.) This new wording is unfortunately inconsistent with the identifier names in the Rust stdlib. It is the identifier names that are wrong, as discussed at length in eg https://doc.rust-lang.org/nightly/std/process/struct.ExitStatus.html https://doc.rust-lang.org/nightly/std/os/unix/process/trait.ExitStatusExt.html Unfortunately for API stability reasons it would be a lot of work, and a lot of disruption, to change the names in the stdlib (eg to rename `std::process::ExitStatus` to `std::process::ChildStatus` or something), but we should fix the message output. Many (probably most) readers of these messages about exit statuses will be users and system administrators, not programmers, who won't even know that Rust has this wrong terminology. So I think the right thing is to fix the documentation (as I have already done) and, now, the terminology in the implementation. This is a user-visible change to the behaviour of all Rust programs which run Unix subprocesses. Hopefully no-one is matching against the exit status string, except perhaps in tests.

Dylan-DPC-zz · 2021-03-26T01:33:51Z

failed in rollup

Dylan-DPC-zz · 2021-03-26T01:34:03Z

@bors r-

"exit code" is wrong terminology on Unix. I am trying to fix this in Rust stdlib in rust-lang/rust#83462 but this currently breaks the cargo test suite. See that MR for full explanation of the change. Signed-off-by: Ian Jackson <[email protected]>

ijackson · 2021-03-26T16:25:38Z

I'm fixing the test in cargo. ISTM that we ought to mention this in the release notes, so let's see if I can do this:

@rustbot modify labels +relnotes

rustbot · 2021-03-26T16:25:39Z

Error: Label relnotes can only be set by Rust team members

Please let @rust-lang/release know if you're having trouble with this bot.

tests: Tolerate "exit status" in error messages "exit code" is wrong terminology on Unix. I am trying to fix this in Rust stdlib in rust-lang/rust#83462 but this currently breaks the cargo test suite. See that MR for full explanation of the change.

ijackson · 2021-03-26T17:33:15Z

@joshtriplett Thanks for getting rust-lang/cargo#9307 merged so quickly! Do you know whether the rust-lang CI tests use cargo main branch, or if I need to wait for the cargo change to be released or something?

joshtriplett · 2021-03-26T17:50:41Z

I believe this will require updating the cargo submodule.

I don't know the policy for doing mid-cycle updates for something like this.

cc @ehuss

ehuss · 2021-03-26T17:54:23Z

There's an update in-flight (#83418) that was blocked. I'll look at moving it forward today without RLS.

ehuss · 2021-03-27T03:38:07Z

#83418 has merged.
@bors retry

ehuss · 2021-03-27T03:39:34Z

@bors r=joshtriplett

bors · 2021-03-27T03:39:35Z

📌 Commit 11e40ce has been approved by joshtriplett

…, r=joshtriplett ExitStatus: print "exit status: {}" rather than "exit code: {}" on unix Proper Unix terminology is "exit status" (vs "wait status"). "exit code" is imprecise on Unix and therefore unclear. (As far as I can tell, "exit code" is correct terminology on Windows.) This new wording is unfortunately inconsistent with the identifier names in the Rust stdlib. It is the identifier names that are wrong, as discussed at length in eg https://doc.rust-lang.org/nightly/std/process/struct.ExitStatus.html https://doc.rust-lang.org/nightly/std/os/unix/process/trait.ExitStatusExt.html Unfortunately for API stability reasons it would be a lot of work, and a lot of disruption, to change the names in the stdlib (eg to rename `std::process::ExitStatus` to `std::process::ChildStatus` or something), but we should fix the message output. Many (probably most) readers of these messages about exit statuses will be users and system administrators, not programmers, who won't even know that Rust has this wrong terminology. So I think the right thing is to fix the documentation (as I have already done) and, now, the terminology in the implementation. This is a user-visible change to the behaviour of all Rust programs which run Unix subprocesses. Hopefully no-one is matching against the exit status string, except perhaps in tests.

Rollup of 10 pull requests Successful merges: - rust-lang#79399 (Use detailed and shorter fs error explaination) - rust-lang#83348 (format macro argument parsing fix) - rust-lang#83462 (ExitStatus: print "exit status: {}" rather than "exit code: {}" on unix) - rust-lang#83526 (lazily calls some fns) - rust-lang#83558 (Use DebugStruct::finish_non_exhaustive() in std.) - rust-lang#83559 (Fix Debug implementation for RwLock{Read,Write}Guard.) - rust-lang#83560 (Derive Debug for io::Chain instead of manually implementing it.) - rust-lang#83561 (Improve Debug implementations of Mutex and RwLock.) - rust-lang#83567 (Update rustup cross-compilation docs link) - rust-lang#83569 (Add regression tests for rust-lang#56445) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

tests: Tolerate "exit status" in error messages "exit code" is wrong terminology on Unix. I am trying to fix this in Rust stdlib in rust-lang/rust#83462 but this currently breaks the cargo test suite. See that MR for full explanation of the change.

XAMPPRocky · 2021-05-21T10:00:40Z

Going to untag this as relnotes, as the stability of Display impls is currently not guaranteed, and this isn't particularly notable besides that as far as I can tell. #72676

rust-highfive assigned sfackler Mar 25, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 25, 2021

ijackson changed the title ~~ExitStatus: print "exit status: {}" rather than "exit code: {}"~~ ExitStatus: print "exit status: {}" rather than "exit code: {}" on unix Mar 25, 2021

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 Mar 25, 2021

Dylan-DPC-zz mentioned this pull request Mar 25, 2021

Rollup of 9 pull requests #83497

Closed

bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Mar 26, 2021

ijackson mentioned this pull request Mar 26, 2021

tests: Tolerate "exit status" in error messages rust-lang/cargo#9307

Merged

Dylan-DPC-zz added the relnotes Marks issues that should be documented in the release notes of the next release. label Mar 26, 2021

ehuss mentioned this pull request Mar 26, 2021

Update cargo #83418

Merged

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 27, 2021

Dylan-DPC-zz mentioned this pull request Mar 27, 2021

Rollup of 8 pull requests #83562

Closed

Dylan-DPC-zz mentioned this pull request Mar 27, 2021

Rollup of 8 pull requests #83566

Closed

JohnTitor mentioned this pull request Mar 27, 2021

Rollup of 10 pull requests #83573

Merged

bors merged commit 3f41fdd into rust-lang:master Mar 27, 2021

rustbot added this to the 1.53.0 milestone Mar 27, 2021

XAMPPRocky removed the relnotes Marks issues that should be documented in the release notes of the next release. label May 21, 2021

ijackson deleted the exitstatus-message-wording branch August 24, 2021 17:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ExitStatus: print "exit status: {}" rather than "exit code: {}" on unix #83462

ExitStatus: print "exit status: {}" rather than "exit code: {}" on unix #83462

ijackson commented Mar 25, 2021

rust-highfive commented Mar 25, 2021

joshtriplett commented Mar 25, 2021

bors commented Mar 25, 2021

Dylan-DPC-zz commented Mar 26, 2021

Dylan-DPC-zz commented Mar 26, 2021

ijackson commented Mar 26, 2021

rustbot commented Mar 26, 2021

ijackson commented Mar 26, 2021

joshtriplett commented Mar 26, 2021

ehuss commented Mar 26, 2021

ehuss commented Mar 27, 2021

ehuss commented Mar 27, 2021

bors commented Mar 27, 2021

XAMPPRocky commented May 21, 2021 •

edited

Loading

ExitStatus: print "exit status: {}" rather than "exit code: {}" on unix #83462

ExitStatus: print "exit status: {}" rather than "exit code: {}" on unix #83462

Conversation

ijackson commented Mar 25, 2021

rust-highfive commented Mar 25, 2021

joshtriplett commented Mar 25, 2021

bors commented Mar 25, 2021

Dylan-DPC-zz commented Mar 26, 2021

Dylan-DPC-zz commented Mar 26, 2021

ijackson commented Mar 26, 2021

rustbot commented Mar 26, 2021

ijackson commented Mar 26, 2021

joshtriplett commented Mar 26, 2021

ehuss commented Mar 26, 2021

ehuss commented Mar 27, 2021

ehuss commented Mar 27, 2021

bors commented Mar 27, 2021

XAMPPRocky commented May 21, 2021 • edited Loading

XAMPPRocky commented May 21, 2021 •

edited

Loading