about summary refs log tree commit diff
path: root/docs/dev
diff options
context:
space:
mode:
authorAleksey Kladov <aleksey.kladov@gmail.com>2020-10-02 10:13:58 +0200
committerAleksey Kladov <aleksey.kladov@gmail.com>2020-10-02 10:13:58 +0200
commit0599e64bb296201b0aa5c637be34e28149d00e5d (patch)
tree67000947cbe688188779b0c66098228929c82369 /docs/dev
parent505ff4070a3de962dbde66f08b6550cda2eb4eab (diff)
downloadrust-0599e64bb296201b0aa5c637be34e28149d00e5d.tar.gz
rust-0599e64bb296201b0aa5c637be34e28149d00e5d.zip
Document Clippy strategy
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/style.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/dev/style.md b/docs/dev/style.md
index f0fdb5adc44..fb407afcdf6 100644
--- a/docs/dev/style.md
+++ b/docs/dev/style.md
@@ -371,3 +371,13 @@ After you are happy with the state of the code, please use [interactive rebase](
 
 Avoid @mentioning people in commit messages and pull request descriptions(they are added to commit message by bors).
 Such messages create a lot of duplicate notification traffic during rebases.
+
+# Clippy
+
+We don't enforce Clippy.
+A number of default lints have high false positive rate.
+Selectively patching false-positives with `allow(clippy)` is considered worse than not using Clippy at all.
+There's `cargo xtask lint` command which runs a subset of low-FPR lints.
+Careful tweaking of `xtask lint` is welcome.
+See also [rust-lang/clippy#5537](https://github.com/rust-lang/rust-clippy/issues/5537).
+Of course, applying Clippy suggestions is welcome as long as they indeed improve the code.