Make `rustup show` output info in a more logical order #3225

majaha · 2023-02-19T11:47:23Z

I ran rustup show and noticed that its output is in the order:
installed toolchains -> installed targets for active toolchain -> active toolchain
I thought it would make sense to put "active toolchain" before " installed targets for active toolchain" so that they in order of decreasing scope:
installed toolchains -> active toolchain -> installed targets for active toolchain
so that is what this patch does 🙂
Thoughts?

Before:

Matt@Matts-PC /c/d/p/r/rustup (show-order)> rustup show
Default host: x86_64-pc-windows-msvc
rustup home:  C:\Users\Matt\.rustup

installed toolchains
--------------------

stable-x86_64-pc-windows-msvc (default)
nightly-x86_64-pc-windows-msvc

installed targets for active toolchain
--------------------------------------

wasm32-unknown-unknown
x86_64-pc-windows-msvc

active toolchain
----------------

stable-x86_64-pc-windows-msvc (default)
rustc 1.67.1 (d5a82bbd2 2023-02-07)

Matt@Matts-PC /c/d/p/r/rustup (show-order)>

After:

Matt@Matts-PC /c/d/p/r/rustup (show-order)> RUSTUP_HOME=home CARGO_HOME=home home/bin/rustup show
Default host: x86_64-pc-windows-msvc
rustup home:  D:\programming\repos\rustup\home

installed toolchains
--------------------

stable-x86_64-pc-windows-msvc (default)
nightly-x86_64-pc-windows-msvc

active toolchain
----------------

stable-x86_64-pc-windows-msvc (default)
rustc 1.67.1 (d5a82bbd2 2023-02-07)

installed targets for active toolchain
--------------------------------------

wasm32-unknown-unknown
x86_64-pc-windows-msvc

Matt@Matts-PC /c/d/p/r/rustup (show-order)>

Fixes #1397

rbtcollins · 2023-02-19T23:14:45Z

My gut reaction is that folk usually want the active toolchain information, so having it first or last is best; and last means they don't need to scan far for it or use head.

Neither first nor last will match your concept though.

Thanks for demonstrating the idea clearly though!

majaha · 2023-02-20T01:11:37Z

Thanks for considering it!

I've fixed the tests I broke, amended the commit and commit message and force pushed. Apologies to anyone who pulled the original commit.

majaha · 2023-02-20T01:30:59Z

There's always rustup show active-toolchain [-v], although it is admittedly longer

Matt@Matts-PC /c/d/p/r/rustup (show-order)> rustup show active-toolchain
stable-x86_64-pc-windows-msvc (default)
Matt@Matts-PC /c/d/p/r/rustup (show-order)> rustup show active-toolchain -v
stable-x86_64-pc-windows-msvc (default)
rustc 1.67.1 (d5a82bbd2 2023-02-07)

majaha · 2023-02-20T02:45:43Z

As an aside, would it be possible to reformat the reason the active toolchain was chosen? At the moment the floating (default) is a little misleading and mysterious if you don't already know what it means. And it visually matches how it looks in "installed toolchains" even though it means something different. (My initial reaction to it was "Why is there a default active toolchain if there can only be one active toolchain? 🤔" but of course, that's not what it means 🙂).

active toolchain
----------------
stable-x86_64-pc-windows-msvc (default)
rustc 1.67.1 (d5a82bbd2 2023-02-07)

->

active toolchain
----------------
stable-x86_64-pc-windows-msvc
rustc 1.67.1 (d5a82bbd2 2023-02-07)
Reason: is the default toolchain
/or/
Reason: overridden by +toolchain on the command line

Also, there's some scope for code deduplication between show_active_toolchain() and show()

workingjubilee · 2023-03-11T06:21:09Z

I feel like "\nReason:" is nondescript (reason for what? it's dissociated from the phrase "active toolchain" by multiple lines by that point) and the " (inline comment)" style is better, but I don't think " (default)" is a good explanation either.

majaha · 2023-03-12T01:46:37Z

It's a little terse, I'll admit. I think because it's right next to the other parts of the active toolchain, you can work out what it's the reason for using context from the reason message. But I would be open to:

active toolchain
----------------
stable-x86_64-pc-windows-msvc
rustc 1.67.1 (d5a82bbd2 2023-02-07)
Reason it's active: it's the default toolchain

Either way, it's certainly more descriptive than the other lines! Perhaps it should really be:

active toolchain
----------------
Toolchain name: stable-x86_64-pc-windows-msvc
Compiler version: rustc 1.67.1 (d5a82bbd2 2023-02-07)
Reason it's active: it's the default toolchain

workingjubilee · 2023-05-09T05:37:54Z

Hm. Why not reframe it and instead

active toolchain: default
----------------
stable-x86_64-pc-windows-msvc
rustc 1.67.1 (d5a82bbd2 2023-02-07)

rbtcollins · 2023-05-28T06:20:49Z

What would happen if we put the reason on the same line as Active toolchain.

Active toolchain (the default)
Active toolchain (selected by RUSTUP_TOOLCHAIN)
...

(or something similar).

Having thought more about this I do like the idea of making targets subordinate to the toolchain. Perhaps like this:

RUSTUP_HOME=home CARGO_HOME=home home/bin/rustup show
Default host: x86_64-pc-windows-msvc
rustup home:  D:\programming\repos\rustup\home

installed toolchains
===================

stable-x86_64-pc-windows-msvc (default)
nightly-x86_64-pc-windows-msvc

active toolchain
================

channel: stable-x86_64-pc-windows-msvc
version: rustc 1.67.1 (d5a82bbd2 2023-02-07)
reason: default
targets: 
--------

wasm32-unknown-unknown
x86_64-pc-windows-msvc

majaha · 2023-05-28T06:51:15Z

Yes, that's definitely an improvement!

Although I think we could do away with the blank lines after the ===== and ----- lines.

djc · 2023-10-26T12:16:57Z

@majaha would you be able to rebase this and follow up on the discussion so far?

majaha · 2023-10-26T19:18:46Z

Okay, I've rebased the old patch.

We're probably not ready to merge yet though, as we were still discussing and iterating on what we wanted to do. I'm going to have another think about what we want here.

majaha · 2023-10-26T23:23:06Z

Okay, I've spent some more time thinking about the output format, incorporating some other's ideas, and this is what I've come up with:

$ rustup show
Default host: x86_64-pc-windows-msvc
rustup home:  C:\Users\Matt\.rustup

installed toolchains
====================
stable-x86_64-pc-windows-msvc (default)
nightly-x86_64-pc-windows-msvc

active toolchain
================
name: stable-x86_64-pc-windows-msvc
compiler: rustc 1.73.0 (cc66ad468 2023-10-03)
active because: overridden by +toolchain on the command line
targets:
--------
wasm32-unknown-unknown
x86_64-pc-windows-msvc

I thought about putting the active reason in the header like this:

active toolchain [by default]
================

but decided against it as the rust-toolchain file override reason can be arbitrarily long, and will probably wrap for some people, causing some headache with what to prevent the wrapped ==== line being ugly:

active toolchain [overridden by 'D:\foo\bar\baz\...\rust-toolchain']
================

We should also change the format of rustup show active-toolchain and split it into two lines:

$ RUSTUP_TOOLCHAIN=nightly rustup show active-toolchain
nightly-x86_64-pc-windows-msvc (environment override by RUSTUP_TOOLCHAIN)

⬇

$ RUSTUP_TOOLCHAIN=nightly rustup show active-toolchain
nightly-x86_64-pc-windows-msvc
active because: environment override by RUSTUP_TOOLCHAIN

rami3l · 2023-11-04T02:51:17Z

$ RUSTUP_TOOLCHAIN=nightly rustup show active-toolchain
nightly-x86_64-pc-windows-msvc
active because: environment override by RUSTUP_TOOLCHAIN

Indeed, breaking that into two lines might be a good idea. @majaha, it looks like we are moving in the right direction!

active toolchain [overridden by 'D:\foo\bar\baz\...\rust-toolchain']
================

I still prefer using active because: here.

However, I'd like to add an (active) in the first section, which is a deliberate duplication but will hopefully make things clearer:

$ rustup show
Default host: x86_64-pc-windows-msvc
rustup home:  C:\Users\Matt\.rustup

installed toolchains
====================
stable-x86_64-pc-windows-msvc (active)
nightly-x86_64-pc-windows-msvc (default)

active toolchain
================
name: stable-x86_64-pc-windows-msvc
compiler: rustc 1.73.0 (cc66ad468 2023-10-03)
active because: overridden by +toolchain on the command line
targets:
--------
wasm32-unknown-unknown
x86_64-pc-windows-msvc

... and we might want to use (active, default) for the non-overridden state.

rami3l · 2023-11-04T02:59:15Z

@rbtcollins @djc Instead of changing to = and - combined as proposed above, what if we keep the -, and add indentation to the mix (IIRC it should be 2 spaces to be coherent)?

<snip>

active toolchain
----------------
name: stable-x86_64-pc-windows-msvc
compiler: rustc 1.73.0 (cc66ad468 2023-10-03)
active because: overridden by +toolchain on the command line
targets:
  wasm32-unknown-unknown
  x86_64-pc-windows-msvc

Other than this I have no outstanding concerns at the moment.

majaha · 2023-11-04T03:01:21Z

I still prefer using active because: here.

Sorry, do you mean that you want it to be on the same line as the header next to active toolchain, or that you want it to be on it's own line underneath?

rami3l · 2023-11-04T03:03:04Z

I still prefer using active because: here.

Sorry, do you mean that you want it to be on the same line as the header next to active toolchain, or that you want it to be on it's own line underneath?

A separate line underneath, just like in my snippets above.

majaha · 2023-11-04T03:07:03Z

Ah, gotcha. Yeah, I think you're version looks quite clean!

djc · 2023-11-20T09:41:58Z

This looks good to me. So can we get the code updated to match the proposed style?

majaha · 2023-11-21T00:59:59Z

Okay, I'm working on this.

Here's a thought I had: Should we always have the installed toolchains and active toolchain -> installed targets lists, even if they have only a single entry? I think that would be clearer and more intuitive. If you haven't seen them before, it's not obvious that their non-presence is giving you information. It's too implicit, you have to go and carefully read the help page to pick up on it.

rami3l · 2023-11-25T04:34:09Z

@majaha As a quick reminder, with the currently proposed style, the output should be like:

$ RUSTUP_TOOLCHAIN=nightly rustup show active-toolchain
nightly-x86_64-pc-windows-msvc
active because: environment override by RUSTUP_TOOLCHAIN

(From #3225 (comment))

... with (active) and (default) in installed toolchains:

$ rustup show
Default host: x86_64-pc-windows-msvc
rustup home:  C:\Users\Matt\.rustup

installed toolchains
--------------------
stable-x86_64-pc-windows-msvc (active)
nightly-x86_64-pc-windows-msvc (default)

active toolchain
----------------
name: stable-x86_64-pc-windows-msvc
compiler: rustc 1.73.0 (cc66ad468 2023-10-03)
active because: overridden by +toolchain on the command line
targets:
  wasm32-unknown-unknown
  x86_64-pc-windows-msvc

(From #3225 (comment))

Also, (active, default) should be used if the default toolchain is active.

(From #3225 (comment))

majaha · 2023-12-05T15:15:40Z

I've uploaded the new patch, which includes the changes and a bit of a refactoring:

Change the output format of rustup show, to be in a more logical
order and have more pleasing formatting
Update the formatting of rustup show active-toolchain and
rustup toolchain list to match the new rustup show format.
rustup +nightly show will no longer install the nightly toolchain
if it isn't already installed. Ditto for
rustup show active-toolchain. Fixes rustup show should not force-install the default toolchain if it is not installed. #1397
Fix a bug where the RUSTUP_TOOLCHAIN environment variable took
priority over the +toolchain command line option, and add a test for
override priority.
rustup default no longer errors when there is no default toolchain
configured, it prints a message instead.
Update the docs, and fix an issue where they incorrectly stated
that rust-toolchain.toml config files couldn't specify custom
names. (Text last touched here, see commit message: 7bfbd3b)

djc · 2023-12-07T08:26:44Z

@majaha this sounds great, except I'd like to request basically one commit per bullet point, which should make it a lot easier to review this. Do you think that would be feasible?

src/cli/download_tracker.rs

Changes the model from "find an override to the default toolchain" to "find the active toolchain, which may be the default toolchain".

Redesigns the `OverrideCfg` type so that validity is represented in the type system, i.e. "Parse, don't validate". Probably fixes some subtle bugs when no toolchain is named in a rust-toolchain.toml, implicitly selecting the default toolchain, but the default toolchain isn't displayed as active by `rustup list toolchain` and the like. Also fixes a bug where the `RUSTUP_TOOLCHAIN` erroneously had priority over a `+toolchain` command line override.

This changes the format of `rustup show` to be in a more logical order, and changes the format of `rustup show active-toolchain` to match. Also, as suggested in a comment, these commands will no longer install the active toolchain if it is not already installed, as they now call `cfg.find_active_toolchain()` instead of `cfg.find_or_install_active_toolchain()`. This fixes rust-lang#1397

Update the format of `rustup toolchain list` to have a similar flavour to the new `rustup show` format.

`rustup default` will no longer error and print to stderr if there is no default toolchain configured. It will print to stdout and exit successfully instead.

Fix an issue where the documentation erroneously states that `rust-toolchain.toml` config files can't specify custom toolchain names. This language seems to be very old, ultimately inherited from the original commit that added this feature, and is no longer true: rust-lang@107d8e5#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R330

majaha · 2024-05-08T08:37:49Z

Nice, well done on merging this guys!

majaha force-pushed the show-order branch from 7b564d8 to af22bd9 Compare February 20, 2023 01:04

majaha changed the title ~~Make "rustc show" output info in a more logical order~~ Make "rustup show" output info in a more logical order Feb 20, 2023

majaha changed the title ~~Make "rustup show" output info in a more logical order~~ Make rustup show output info in a more logical order Feb 20, 2023

rami3l mentioned this pull request Oct 5, 2023

1.27.0 release planning #3501

Closed

majaha force-pushed the show-order branch from af22bd9 to b83ef4e Compare October 26, 2023 19:15

rami3l mentioned this pull request Nov 5, 2023

Add a "single column" mode for rustup toolchain list and friends #3519

Closed

majaha force-pushed the show-order branch from b83ef4e to 17b7fb8 Compare December 5, 2023 15:05

majaha force-pushed the show-order branch from 17b7fb8 to c0442bb Compare December 5, 2023 15:40

rami3l force-pushed the show-order branch from 0ed4b4a to 4609d1a Compare May 4, 2024 11:34

djc reviewed May 7, 2024

View reviewed changes

src/cli/download_tracker.rs Outdated Show resolved Hide resolved

majaha added 5 commits May 8, 2024 09:13

Pull out ensure_installed()

bc907aa

Pull out new_toolchain_with_reason()

90ba7d4

Change find_override to find_active_toolchain

4a84b8a

Changes the model from "find an override to the default toolchain" to "find the active toolchain, which may be the default toolchain".

Pull match statement out in OverrideCfg::from_file()

a94bb6f

rami3l force-pushed the show-order branch 3 times, most recently from 16886db to 8f8f4ca Compare May 8, 2024 01:52

rami3l requested a review from djc May 8, 2024 02:04

majaha added 6 commits May 8, 2024 10:23

Update format of toolchain list

cf852f7

Update the format of `rustup toolchain list` to have a similar flavour to the new `rustup show` format.

Make rustup default not error if no default

12f7374

`rustup default` will no longer error and print to stderr if there is no default toolchain configured. It will print to stdout and exit successfully instead.

Make settings file allow multiple borrows

2f9a8d0

Make find_override_from_dir_walk return OverrideCfg

b3efa0c

rami3l force-pushed the show-order branch from 8f8f4ca to b3efa0c Compare May 8, 2024 02:23

rami3l added this pull request to the merge queue May 8, 2024

Merged via the queue into rust-lang:master with commit 2345c2c May 8, 2024
22 checks passed

TonalidadeHidrica mentioned this pull request May 11, 2024

rustup causes rustc invocation to automatically download toolchain IlanCosman/tide#444

Open

rami3l mentioned this pull request Jun 9, 2024

toolchain list should give more help with overrides #3097

Open

This was referenced Jul 10, 2024

Do not install toolchain on rustup show * and rustup --version #2658

Closed

rustup show should not force-install the default toolchain if it is not installed. #1397

Closed

rami3l mentioned this pull request Jul 30, 2024

Tracking: Rustup should not perform implicit installations #3635

Closed

5 tasks

rami3l mentioned this pull request Aug 8, 2024

feat(cli)!: remove implicit toolchain installation #3985

Merged

zjp-CN mentioned this pull request Aug 25, 2024

feat: 识别 rust-toolchain.toml 文件 os-checker/os-checker#29

Closed

3 tasks

rami3l mentioned this pull request Oct 6, 2024

dist: bump rustup version to 1.28.0 #4041

Draft

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make `rustup show` output info in a more logical order #3225

Make `rustup show` output info in a more logical order #3225

majaha commented Feb 19, 2023 •

edited

Loading

rbtcollins commented Feb 19, 2023

majaha commented Feb 20, 2023

majaha commented Feb 20, 2023

majaha commented Feb 20, 2023

workingjubilee commented Mar 11, 2023

majaha commented Mar 12, 2023

workingjubilee commented May 9, 2023

rbtcollins commented May 28, 2023

majaha commented May 28, 2023

djc commented Oct 26, 2023 •

edited

Loading

majaha commented Oct 26, 2023

majaha commented Oct 26, 2023

rami3l commented Nov 4, 2023 •

edited

Loading

rami3l commented Nov 4, 2023 •

edited

Loading

majaha commented Nov 4, 2023

rami3l commented Nov 4, 2023 •

edited

Loading

majaha commented Nov 4, 2023

djc commented Nov 20, 2023

majaha commented Nov 21, 2023

rami3l commented Nov 25, 2023 •

edited

Loading

majaha commented Dec 5, 2023 •

edited

Loading

djc commented Dec 7, 2023

majaha commented May 8, 2024

Make rustup show output info in a more logical order #3225

Make rustup show output info in a more logical order #3225

Conversation

majaha commented Feb 19, 2023 • edited Loading

rbtcollins commented Feb 19, 2023

majaha commented Feb 20, 2023

majaha commented Feb 20, 2023

majaha commented Feb 20, 2023

workingjubilee commented Mar 11, 2023

majaha commented Mar 12, 2023

workingjubilee commented May 9, 2023

rbtcollins commented May 28, 2023

majaha commented May 28, 2023

djc commented Oct 26, 2023 • edited Loading

majaha commented Oct 26, 2023

majaha commented Oct 26, 2023

rami3l commented Nov 4, 2023 • edited Loading

rami3l commented Nov 4, 2023 • edited Loading

majaha commented Nov 4, 2023

rami3l commented Nov 4, 2023 • edited Loading

majaha commented Nov 4, 2023

djc commented Nov 20, 2023

majaha commented Nov 21, 2023

rami3l commented Nov 25, 2023 • edited Loading

majaha commented Dec 5, 2023 • edited Loading

djc commented Dec 7, 2023

majaha commented May 8, 2024

Make `rustup show` output info in a more logical order #3225

Make `rustup show` output info in a more logical order #3225

majaha commented Feb 19, 2023 •

edited

Loading

djc commented Oct 26, 2023 •

edited

Loading

rami3l commented Nov 4, 2023 •

edited

Loading

rami3l commented Nov 4, 2023 •

edited

Loading

rami3l commented Nov 4, 2023 •

edited

Loading

rami3l commented Nov 25, 2023 •

edited

Loading

majaha commented Dec 5, 2023 •

edited

Loading