Skip to content

Commit ab0f5bb

Browse files
majaharami3l
authored andcommitted
Clarify several docs and help messages
1 parent e9de885 commit ab0f5bb

10 files changed

+21
-14
lines changed

doc/user-guide/src/concepts/profiles.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,22 @@ available at this time are `minimal`, `default`, and `complete`:
2020
install the needed additional components manually, either by using `rustup
2121
component add` or by using `-c` when installing the toolchain.
2222

23-
To change the `rustup` profile you can use the `rustup set profile` command.
23+
To change the profile `rustup install` uses by default, you can use the
24+
`rustup set profile` command.
2425
For example, to select the minimal profile you can use:
2526

2627
```console
2728
rustup set profile minimal
2829
```
2930

30-
It's also possible to choose the profile when installing `rustup` for the
31-
first time, either interactively by choosing the "Customize installation"
31+
You can also directly select the profile used when installing a toolchain with:
32+
33+
```console
34+
rustup install --profile <name>
35+
```
36+
37+
It's also possible to choose the default profile when installing `rustup` for
38+
the first time, either interactively by choosing the "Customize installation"
3239
option or programmatically by passing the `--profile=<name>` flag. Profiles
3340
will only affect newly installed toolchains: as usual it will be possible to
3441
install individual components later with: `rustup component add`.

src/cli/rustup_mode.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ pub(crate) fn cli() -> Command {
304304
Command::new("home")
305305
.about("Display the computed value of RUSTUP_HOME"),
306306
)
307-
.subcommand(Command::new("profile").about("Show the current profile"))
307+
.subcommand(Command::new("profile").about("Show the default profile used for the `rustup install` command"))
308308
)
309309
.subcommand(
310310
Command::new("install")
@@ -625,7 +625,7 @@ pub(crate) fn cli() -> Command {
625625
)
626626
.subcommand(
627627
Command::new("override")
628-
.about("Modify directory toolchain overrides")
628+
.about("Modify toolchain overrides for directories")
629629
.after_help(OVERRIDE_HELP)
630630
.subcommand_required(true)
631631
.arg_required_else_help(true)
@@ -784,7 +784,7 @@ pub(crate) fn cli() -> Command {
784784
)
785785
.subcommand(
786786
Command::new("profile")
787-
.about("The default components installed")
787+
.about("The default components installed with a toolchain")
788788
.arg(
789789
Arg::new("profile-name")
790790
.required(true)

tests/suite/cli-ui/rustup/rustup_help_cmd_stdout.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Commands:
1616
toolchain Modify or query the installed toolchains
1717
target Modify a toolchain's supported targets
1818
component Modify a toolchain's installed components
19-
override Modify directory toolchain overrides
19+
override Modify toolchain overrides for directories
2020
run Run a command with an environment configured for a given toolchain
2121
which Display which binary will be run for a given command
2222
doc Open the documentation for the current toolchain

tests/suite/cli-ui/rustup/rustup_help_flag_stdout.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Commands:
1616
toolchain Modify or query the installed toolchains
1717
target Modify a toolchain's supported targets
1818
component Modify a toolchain's installed components
19-
override Modify directory toolchain overrides
19+
override Modify toolchain overrides for directories
2020
run Run a command with an environment configured for a given toolchain
2121
which Display which binary will be run for a given command
2222
doc Open the documentation for the current toolchain

tests/suite/cli-ui/rustup/rustup_only_options_stdout.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Commands:
1616
toolchain Modify or query the installed toolchains
1717
target Modify a toolchain's supported targets
1818
component Modify a toolchain's installed components
19-
override Modify directory toolchain overrides
19+
override Modify toolchain overrides for directories
2020
run Run a command with an environment configured for a given toolchain
2121
which Display which binary will be run for a given command
2222
doc Open the documentation for the current toolchain

tests/suite/cli-ui/rustup/rustup_override_cmd_help_flag_stdout.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ bin.name = "rustup"
22
args = ["override","--help"]
33
stdout = """
44
...
5-
Modify directory toolchain overrides
5+
Modify toolchain overrides for directories
66
77
Usage: rustup[EXE] override <COMMAND>
88

tests/suite/cli-ui/rustup/rustup_set_cmd_help_flag_stdout.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Usage: rustup[EXE] set <COMMAND>
88
99
Commands:
1010
default-host The triple used to identify toolchains when not specified
11-
profile The default components installed
11+
profile The default components installed with a toolchain
1212
auto-self-update The rustup auto self update mode
1313
help Print this message or the help of the given subcommand(s)
1414

tests/suite/cli-ui/rustup/rustup_set_cmd_profile_cmd_help_flag_stdout.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ bin.name = "rustup"
22
args = ["set","profile","--help"]
33
stdout = """
44
...
5-
The default components installed
5+
The default components installed with a toolchain
66
77
Usage: rustup[EXE] set profile <profile-name>
88

tests/suite/cli-ui/rustup/rustup_show_cmd_help_flag_stdout.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Usage: rustup[EXE] show [OPTIONS] [COMMAND]
99
Commands:
1010
active-toolchain Show the active toolchain
1111
home Display the computed value of RUSTUP_HOME
12-
profile Show the current profile
12+
profile Show the default profile used for the `rustup install` command
1313
help Print this message or the help of the given subcommand(s)
1414
1515
Options:

tests/suite/cli-ui/rustup/rustup_show_cmd_profile_cmd_help_flag_stdout.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ bin.name = "rustup"
22
args = ["show","profile","--help"]
33
stdout = """
44
...
5-
Show the current profile
5+
Show the default profile used for the `rustup install` command
66
77
Usage: rustup[EXE] show profile
88

0 commit comments

Comments
 (0)