dnrops
/
rust
mirror of https://github.com/rust-lang/rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2921 from yaahallo/master 

Update readme for new clippy install method
This commit is contained in:
Manish Goregaokar 2018-07-16 13:38:09 -07:00 committed by GitHub
parent 2a016890a0 29cae6263b
commit e22928c23c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -35,44 +35,45 @@ Table of contents:
Since this is a tool for helping the developer of a library or application Since this is a tool for helping the developer of a library or application
write better code, it is recommended not to include Clippy as a hard dependency. write better code, it is recommended not to include Clippy as a hard dependency.
Options include using it as an optional dependency, as a cargo subcommand, or Options include using it as an optional dependency, as a cargo subcommand, or
as an included feature during build. All of these options are detailed below. as an included feature during build. These options are detailed below.
### As a cargo subcommand (`cargo clippy`)
One way to use Clippy is by installing Clippy through rustup as a cargo
subcommand.
#### Step 1: Install rustup
You can install [rustup](http://rustup.rs/) on supported platforms. This will help
us install clippy and its dependencies.
If you already have rustup installed, update to ensure you have the latest
rustup and compiler:
```terminal
rustup update
```
#### Step 2: Install nightly toolchain
As a general rule Clippy will only work with the *latest* Rust nightly for now. As a general rule Clippy will only work with the *latest* Rust nightly for now.
To install Rust nightly, the recommended way is to use [rustup](https://rustup.rs/): To install Rust nightly with [rustup](https://rustup.rs/):
```terminal ```terminal
rustup install nightly rustup install nightly
``` ```
### As a cargo subcommand (`cargo clippy`) #### Step 3: Install clippy
One way to use Clippy is by installing Clippy through cargo as a cargo Once you have rustup and the nightly toolchain installed, run the following command:
subcommand.
```terminal ```terminal
cargo +nightly install clippy rustup component add clippy-preview --toolchain=nightly
``` ```
(The `+nightly` is not necessary if your default `rustup` install is nightly)
Now you can run Clippy by invoking `cargo +nightly clippy`. Now you can run Clippy by invoking `cargo +nightly clippy`.
To update the subcommand together with the latest nightly use the [rust-update](rust-update) script or run:
```terminal
rustup update nightly
cargo +nightly install --force clippy
```
In case you are not using rustup, you need to set the environment flag
`SYSROOT` during installation so Clippy knows where to find `librustc` and
similar crates.
```terminal
SYSROOT=/path/to/rustc/sysroot cargo install clippy
```
### Running Clippy from the command line without installing it ### Running Clippy from the command line without installing it
To have cargo compile your crate with Clippy without Clippy installation To have cargo compile your crate with Clippy without Clippy installation