X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=9ca5761a2ba406d941b671626d5b2efdff416728;hb=ee07fa82a42e0964483bf9dfe170be254c38dbd4;hp=3a56bce4f13905a48fe55c9e7b59fe4ab009b5d8;hpb=0da3521eb6161cc855da65e6f0c7308147b22ba7;p=rust.git diff --git a/README.md b/README.md index 3a56bce4f13..9ca5761a2ba 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code. -[There are 297 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html) +[There are 299 lints included in this crate!](https://rust-lang.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: @@ -125,13 +125,18 @@ before_script: # etc ``` +Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code. +That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause +an error for clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command +line. (You can swap `clippy::all` with the specific lint category you are targeting.) + ## Configuration Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable = value` mapping eg. ```toml blacklisted-names = ["toto", "tata", "titi"] -cyclomatic-complexity-threshold = 30 +cognitive-complexity-threshold = 30 ``` See the [list of lints](https://rust-lang.github.io/rust-clippy/master/index.html) for more information about which lints can be configured and the