]> git.lizzy.rs Git - rust.git/commitdiff
Mention that -D warnings will deny ALL warnings, not just clippy warnings
authorSunjay Varma <sunjay@users.noreply.github.com>
Mon, 8 Apr 2019 17:51:54 +0000 (13:51 -0400)
committerGitHub <noreply@github.com>
Mon, 8 Apr 2019 17:51:54 +0000 (13:51 -0400)
README.md

index 43b477d2cef3e2d839850d1ba572c8c4731ccbc6..4f573adbc019ceb3dd42e14be54ac65480255f2e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -125,6 +125,11 @@ 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 targetting.)
+
 ## Configuration
 
 Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable = value` mapping eg.