Skip to content

rustup is an installer, but install is not discoverable from rustup --help #4269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
2 tasks done
alexanderkjeldaas opened this issue Mar 28, 2025 · 5 comments · Fixed by #4272
Closed
2 tasks done
Milestone

Comments

@alexanderkjeldaas
Copy link

alexanderkjeldaas commented Mar 28, 2025

Verification

Problem

The issue is about discoverability of rustup.

rustup is a "toolchain INSTALLER". However:

$ rustup --help 2>&1 | grep install                                                                                                          127
The Rust toolchain installer
  show         Show the active and installed toolchains or profiles
  toolchain    Modify or query the installed toolchains
  component    Modify a toolchain's installed components
  self         Modify the rustup installation
    Rustup installs The Rust Programming Language from the official

There is no command to install anything. There are commands to modify and show and query toolchains, and modify a toolchain, and modify rustup itself.

But no command to INSTALL a toolchain! There should be something in --help that indicate which command is used to install a toolchain.

Image

Steps

rustup --help

Possible Solution(s)

Show an example installing the latest toolchain in the help.

Notes

No response

Rustup version

1.27.1

Installed toolchains

there is nothing installed

OS version

Nixos
@rami3l
Copy link
Member

rami3l commented Mar 29, 2025

@alexanderkjeldaas Thanks for your report. You seem to be looking for the rustup toolchain install command.

Indeed the subcommand description might not be absolutely clear to a fresh pair of eyes, and we will try to fix that.

@rami3l rami3l added the E-easy label Mar 29, 2025
@rami3l rami3l added this to the 1.28.2 milestone Mar 29, 2025
@djc
Copy link
Contributor

djc commented Mar 29, 2025

Honestly "Modify or query the installed toolchains" doesn't seem that bad, and at least includes the "install" keyword.

@alexanderkjeldaas
Copy link
Author

I think if the toolchain command included the "install" word, then it would be better, like "Install, modify, or query toolchains" or something similar.

@rami3l
Copy link
Member

rami3l commented Mar 30, 2025

I think if the toolchain command included the "install" word, then it would be better, like "Install, modify, or query toolchains" or something similar.

@djc That's what I'm thinking about as well. I guess "modify" implies installed toolchains so the current help message can be optimized after all...

@djc
Copy link
Contributor

djc commented Mar 30, 2025

Proposed some tweaks in #4272.

@djc djc closed this as completed in #4272 Mar 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants