Merge pull request #3113 from mikerite/fix-3112

[rust.git] / README.md

diff --git a/README.md b/README.md
index 5bd3981260e15ad08d53137eb552e7f3bd9ef4f4..98f712c28d82176c4ba9cbd4fba680918d8cf2c1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,14 +13,14 @@ A collection of lints to catch common mistakes and improve your [Rust](https://g
 
 We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you:
 
-* `clippy` (everything that has no false positives)
-* `clippy_pedantic` (everything)
-* `clippy_nursery` (new lints that aren't quite ready yet)
-* `clippy_style` (code that should be written in a more idiomatic way)
-* `clippy_complexity` (code that does something simple but in a complex way)
-* `clippy_perf` (code that can be written in a faster way)
-* `clippy_cargo` (checks against the cargo manifest)
-* **`clippy_correctness`** (code that is just outright wrong or very very useless)
+* `clippy::all` (everything that has no false positives)
+* `clippy::pedantic` (everything)
+* `clippy::nursery` (new lints that aren't quite ready yet)
+* `clippy::style` (code that should be written in a more idiomatic way)
+* `clippy::complexity` (code that does something simple but in a complex way)
+* `clippy::perf` (code that can be written in a faster way)
+* `clippy::cargo` (checks against the cargo manifest)
+* **`clippy::correctness`** (code that is just outright wrong or very very useless)
 
 More to come, please [file an issue](https://github.com/rust-lang-nursery/rust-clippy/issues) if you have ideas!
 
@@ -35,44 +35,46 @@ Table of contents:
 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.
 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 general rule Clippy will only work with the *latest* Rust nightly for now.
+### As a cargo subcommand (`cargo clippy`)
 
-To install Rust nightly, the recommended way is to use [rustup](https://rustup.rs/):
+One way to use Clippy is by installing Clippy through rustup as a cargo
+subcommand.
 
-```terminal
-rustup install nightly
-```
+#### Step 1: Install rustup
 
-### As a cargo subcommand (`cargo clippy`)
+You can install [rustup](http://rustup.rs/) on supported platforms. This will help
+us install clippy and its dependencies.
 
-One way to use Clippy is by installing Clippy through cargo as a cargo
-subcommand.
+If you already have rustup installed, update to ensure you have the latest
+rustup and compiler:
 
 ```terminal
-cargo +nightly install clippy
+rustup update
 ```
 
-(The `+nightly` is not necessary if your default `rustup` install is nightly)
+#### Step 2: Install nightly toolchain
 
-Now you can run Clippy by invoking `cargo +nightly clippy`.
+Rustup integration is still new, you will need a relatively new nightly (2018-07-15 or later).
 
-To update the subcommand together with the latest nightly use the [rust-update](rust-update) script or run:
+To install Rust nightly with [rustup](https://rustup.rs/):
 
 ```terminal
-rustup update nightly
-cargo +nightly install --force clippy
+rustup install nightly
 ```
 
-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.
+#### Step 3: Install clippy
+
+Once you have rustup and the nightly toolchain installed, run the following command:
 
 ```terminal
-SYSROOT=/path/to/rustc/sysroot cargo install clippy
+rustup component add clippy-preview --toolchain=nightly
 ```
 
+Now you can run Clippy by invoking `cargo +nightly clippy`. If nightly is your
+default toolchain in rustup, `cargo clippy` will work fine.
+
 ### Running Clippy from the command line without installing it
 
 To have cargo compile your crate with Clippy without Clippy installation
@@ -104,26 +106,18 @@ define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 
 You can add options  to `allow`/`warn`/`deny`:
 
-*   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy)]`)
+*   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`)
 
-*   all lints using both the `clippy` and `clippy_pedantic` lint groups (`#![deny(clippy)]`,
-    `#![deny(clippy_pedantic)]`). Note that `clippy_pedantic` contains some very aggressive
+*   all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
+    `#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
     lints prone to false positives.
 
-*   only some lints (`#![deny(single_match, box_vec)]`, etc)
+*   only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc)
 
 *   `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
 
 Note: `deny` produces errors instead of warnings.
 
-For convenience, `cargo clippy` automatically defines a `cargo-clippy`
-feature. This lets you set lint levels and compile with or without Clippy
-transparently:
-
-```rust
-#[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]
-```
-
 ## Updating rustc
 
 Sometimes, rustc moves forward without Clippy catching up. Therefore updating