Skip to content

Commit c349967

Browse files
authored
Merge pull request #2768 from pierwill/pierwill/edit-basics
docs: Edit "Basic usage" page
2 parents c5babf5 + b42ebab commit c349967

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

doc/src/basics.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
11
# Basic usage
22

3-
The `rustup` command-line has a built-in help system that provides more
4-
information about each command. Run `rustup help` for an overview. Detailed
5-
help for each subcommand is also available. For example, run `rustup toolchain
6-
install --help` for specifics on installing [toolchains].
7-
8-
[toolchains]: concepts/toolchains.md
9-
103
## Keeping Rust up to date
114

125
Rust is distributed on three different [release channels]: stable, beta, and
13-
nightly. `rustup` is configured to use the stable channel by default, which
14-
represents the latest release of Rust, and is released every six weeks.
6+
nightly. `rustup` uses the stable channel by default, which
7+
represents the latest release of Rust. Stable publishes new releases every six weeks.
158

169
[release channels]: concepts/channels.md
1710

18-
When a new version of Rust is released, you can type `rustup update` to update
19-
to it:
11+
When a new version of Rust is released, simply type `rustup update` to update:
2012

2113
```console
2214
$ rustup update
@@ -36,22 +28,29 @@ info: downloading self-updates
3628

3729
```
3830

39-
This is the essence of `rustup`.
31+
## Keeping `rustup` up to date
4032

41-
## Keeping rustup up to date
42-
43-
Running `rustup update` also checks for updates to `rustup` and automatically
44-
installs the latest version. To manually check for updates and install the
45-
latest version of `rustup` without updating installed toolchains type `rustup
46-
self update`:
33+
Running `rustup update` also checks for updates to `rustup` itself and automatically
34+
installs the latest version. To manually update `rustup` only,
35+
without updating installed toolchains, type `rustup self update`:
4736

4837
```console
4938
$ rustup self update
5039
info: checking for self-updates
5140
info: downloading self-updates
5241
```
5342

54-
**Note**: `rustup` will automatically update itself at the end of any
55-
toolchain installation as well. You can prevent this automatic behaviour by
56-
passing the `--no-self-update` argument when running `rustup update` or
57-
`rustup toolchain install`.
43+
> #### Disable automatic self-updates
44+
> `rustup` will automatically update itself at the end of any toolchain installation.
45+
> You can prevent this automatic behaviour by passing the `--no-self-update` argument
46+
> when running `rustup update` or `rustup toolchain install`.
47+
48+
## Help system
49+
50+
The `rustup` command-line has a built-in help system that provides more
51+
information about each command. Run `rustup help` for an overview. Detailed
52+
help for each subcommand is also available. For example, run `rustup toolchain
53+
install --help` for specifics on installing [toolchains].
54+
55+
[toolchains]: concepts/toolchains.md
56+

0 commit comments

Comments
 (0)