Skip to content

Add common commands section in help text#4651

Merged
rami3l merged 1 commit intorust-lang:mainfrom
dingxiangfei2009:first-landing-glide-slope
Jan 31, 2026
Merged

Add common commands section in help text#4651
rami3l merged 1 commit intorust-lang:mainfrom
dingxiangfei2009:first-landing-glide-slope

Conversation

@dingxiangfei2009
Copy link
Contributor

@dingxiangfei2009 dingxiangfei2009 commented Dec 19, 2025

Judging from user feedback coming out of Debian distros, it appears that after installing rustup from the package manager it is not immediately clear which command actually installs the toolchain. It is true that rustup from rustup.rs one-liner makes one-stop installation, Debian packaging actually skips the essential rustup-init step as of writing for a good reason. This left a few Debian users, who I talked to recently, feel lost in their first attempt to use the toolchain.

This patch adds a small text so that after installation of rustup, which normally does not invoke the toolchain installation for the user, the user can still receive guidance on how to set up the local toolchain immediately.

@djc
Copy link
Contributor

djc commented Dec 19, 2025

I think it would be good to try and address this problem, but not sure adding a "common commands" section to the end is the best way to do it. Wonder if we can add this to the top, either as part of Usage: or even before that.

@rami3l
Copy link
Member

rami3l commented Dec 19, 2025

I think it would be good to try and address this problem, but not sure adding a "common commands" section to the end is the best way to do it.

I would like to disagree with @djc on that matter, as when a command is executed, the first thing I see is the last lines of its output, which is different from when reading a normal doc page.


OTOH I do think the case for Debian is still somewhat particular, since installing via APT technically still has quite limited support notably because it explicitly bypasses the rustup-init stage.

We have tried to improve the situation in both our docs and, in my case, its homebrew packaging:

> brew install rustup
[..]
==> Caveats
To initialize `rustup`, set a default toolchain:
  rustup default stable

If you have `rust` installed, ensure you have "$(brew --prefix rustup)/bin"
before "$(brew --prefix)/bin" in your $PATH:
  https://rust-lang.github.io/rustup/installation/already-installed-rust.html

So the policy that I had in the past would be to acknowledge this as the package manager/maintainer's responsibility. Can something similar be done on Debian's side?

@dingxiangfei2009 dingxiangfei2009 force-pushed the first-landing-glide-slope branch from 770dbdc to 03c519d Compare December 22, 2025 10:12
@dingxiangfei2009
Copy link
Contributor Author

I would also prefer to leave the common commands as the last lines of the help text, so that this information does not scroll away in the terminal print out.

As for Debian, I am currently researching a way to update the package description of rustup so that one can be guided to initiate the missing init step, like how homebrew guides the users.

Copy link
Member

@rami3l rami3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM modulo one tiny bit :)

Judging from user feedback coming out of Debian
distros, it appears that after installing `rustup`
from the package manager it is not immediately
clear which command installs the toolchain.
This patch adds a small text so that after
installation of `rustup`, which normally does not
invoke the toolchain installation for the user,
the user can still receive guidance on how to set
up the local toolchain immediately.

Signed-off-by: Xiangfei Ding <dingxiangfei2009@protonmail.ch>
@dingxiangfei2009 dingxiangfei2009 force-pushed the first-landing-glide-slope branch from 03c519d to afdf053 Compare December 22, 2025 10:37
@rami3l rami3l self-assigned this Jan 28, 2026
@rami3l rami3l mentioned this pull request Jan 31, 2026
5 tasks
@rami3l rami3l added this to the 1.29.0 milestone Jan 31, 2026
@rami3l rami3l added this pull request to the merge queue Jan 31, 2026
Merged via the queue into rust-lang:main with commit 5341187 Jan 31, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants