Skip to content

Commit 4a64903

Browse files
authored
Use cargo dev setup toolchain in install from source docs (#14766)
changelog: none
2 parents d8726ca + 33f81c0 commit 4a64903

File tree

1 file changed

+9
-19
lines changed

1 file changed

+9
-19
lines changed

book/src/development/basics.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -145,42 +145,32 @@ unclear to you.
145145
If you are hacking on Clippy and want to install it from source, do the
146146
following:
147147

148-
First, take note of the toolchain
149-
[override](https://rust-lang.github.io/rustup/overrides.html) in
150-
`/rust-toolchain.toml`. We will use this override to install Clippy into the right
151-
toolchain.
152-
153-
> Tip: You can view the active toolchain for the current directory with `rustup
154-
> show active-toolchain`.
155-
156148
From the Clippy project root, run the following command to build the Clippy
157-
binaries and copy them into the toolchain directory. This will override the
158-
currently installed Clippy component.
149+
binaries and copy them into the toolchain directory. This will create a new
150+
toolchain called `clippy` by default, see `cargo dev setup toolchain --help`
151+
for other options.
159152

160153
```terminal
161-
cargo build --release --bin cargo-clippy --bin clippy-driver -Zunstable-options --out-dir "$(rustc --print=sysroot)/bin"
154+
cargo dev setup toolcahin
162155
```
163156

164-
Now you may run `cargo clippy` in any project, using the toolchain where you
165-
just installed Clippy.
157+
Now you may run `cargo +clippy clippy` in any project using the new toolchain.
166158

167159
```terminal
168160
cd my-project
169-
cargo +nightly-2021-07-01 clippy
161+
cargo +clippy clippy
170162
```
171163

172164
...or `clippy-driver`
173165

174166
```terminal
175-
clippy-driver +nightly-2021-07-01 <filename>
167+
clippy-driver +clippy <filename>
176168
```
177169

178-
If you need to restore the default Clippy installation, run the following (from
179-
the Clippy project root).
170+
If you no longer need the toolchain it can be uninstalled using `rustup`:
180171

181172
```terminal
182-
rustup component remove clippy
183-
rustup component add clippy
173+
rustup toolchain uninstall clippy
184174
```
185175

186176
> **DO NOT** install using `cargo install --path . --force` since this will

0 commit comments

Comments
 (0)