Skip to content

Commit

Permalink
Mention that -D warnings will deny ALL warnings, not just clippy warn…
Browse files Browse the repository at this point in the history
…ings
  • Loading branch information
sunjay committed Apr 8, 2019
1 parent 949f584 commit 5fab7ec
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Expand Up @@ -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.
Expand Down

0 comments on commit 5fab7ec

Please sign in to comment.