]> git.lizzy.rs Git - rust.git/blobdiff - README.md
Split up match_bool UI tests
[rust.git] / README.md
index 8ccc148942d260ab04950c4ec7724e8a5f791c54..260691faa00b6f698e4910ab4ad1fa02ee5666d5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,7 +7,16 @@
 
 A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.
 
-[There are 208 lints included in this crate!](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
+[There are 249 lints included in this crate!](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
+
+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_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_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!
 
@@ -26,6 +35,12 @@ as an included feature during build. All of these options are detailed below.
 
 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/):
+
+```terminal
+rustup install nightly
+```
+
 ### As a cargo subcommand (`cargo clippy`)
 
 One way to use clippy is by installing clippy through cargo as a cargo
@@ -39,6 +54,13 @@ cargo +nightly install 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.
@@ -182,7 +204,7 @@ You can add options  to `allow`/`warn`/`deny`:
 Note: `deny` produces errors instead of warnings.
 
 For convenience, `cargo clippy` automatically defines a `cargo-clippy`
-features. This lets you set lints level and compile with or without clippy
+feature. This lets you set lint levels and compile with or without clippy
 transparently:
 
 ```rust