Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion src/cli/help.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,18 @@ pub(crate) fn rustup_help() -> String {
for common platforms.

If you are new to Rust consider running `rustup doc --book` to
learn Rust."
learn Rust.

{HEADER}Common commands:{HEADER:#}

Update Rust toolchains and rustup
Copy link
Member

@rami3l rami3l Dec 22, 2025

Choose a reason for hiding this comment

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

Nit: I've just compared that with tldr where we have descriptions followed by commands, and that's more intuitive IMHO:

> tldr cargo
[..]
  Manage Rust projects and their module dependencies (crates).
  Some subcommands such as `build` have their own usage documentation.
  More information: <https://doc.rust-lang.org/stable/cargo/>.

  Search for crates:

      cargo search search_string

  Install a binary crate:

      cargo install crate_name
[..]

@epage Does cargo have a similar section that we need to align format with?

Copy link
Author

Choose a reason for hiding this comment

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

Yeah it looks much better. Suggestion applied.

Copy link
Member

Choose a reason for hiding this comment

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

@dingxiangfei2009 Thanks! Let's wait for the final confirmation to see if there's any alignments to be made and I believe we are done :)


{LITERAL}$ rustup update{LITERAL:#}

Install the current stable release of Rust for your host platform

{LITERAL}$ rustup toolchain install stable{LITERAL:#}
"
)
}

Expand Down
22 changes: 21 additions & 1 deletion tests/suite/cli_rustup_ui/rustup_help_cmd.stdout.term.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 21 additions & 1 deletion tests/suite/cli_rustup_ui/rustup_help_flag.stdout.term.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 22 additions & 2 deletions tests/suite/cli_rustup_ui/rustup_only_options.stderr.term.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.