Skip to content

Commit 22c3f4b

Browse files
committed
Document the configuration file
1 parent 784d2c8 commit 22c3f4b

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,5 +219,21 @@ And, in your `main.rs` or `lib.rs`:
219219
#![cfg_attr(feature="clippy", plugin(clippy))]
220220
```
221221

222+
## Configuration
223+
Some lints can be configured in a `Clippy.toml` file. It contains basic `variable = value` mapping eg.
224+
225+
```toml
226+
blacklisted-names = ["toto", "tata", "titi"]
227+
cyclomatic-complexity-threshold = 30
228+
```
229+
230+
See the wiki for more information about which lints can be configured and the
231+
meaning of the variables.
232+
233+
You can also specify the path to the configuration file with:
234+
```rust
235+
#![plugin(clippy(conf_file="path/to/clippy's/configuration"))]
236+
```
237+
222238
##License
223239
Licensed under [MPL](https://www.mozilla.org/MPL/2.0/). If you're having issues with the license, let me know and I'll try to change it to something more permissive.

0 commit comments

Comments
 (0)