about summary refs log tree commit diff
diff options
context:
space:
mode:
authorOliver S̶c̶h̶n̶e̶i̶d̶e̶r Scherer <github35764891676564198441@oli-obk.de>2018-10-12 13:16:34 +0200
committerGitHub <noreply@github.com>2018-10-12 13:16:34 +0200
commit7557269db2ca3d891d31470cbf7982df15827ae2 (patch)
tree5d682f95ecfd9982ea82619d10829bb2003fd48a
parente03a06b28530ef219fbae8607e0b8e08243fa039 (diff)
parent4e2062518775c7c42db48aea2678d16eaba2d72b (diff)
downloadrust-7557269db2ca3d891d31470cbf7982df15827ae2.tar.gz
rust-7557269db2ca3d891d31470cbf7982df15827ae2.zip
Merge pull request #3301 from sigustin/patch-1
Specify which categories are enabled by default
-rw-r--r--README.md9
-rw-r--r--clippy_lints/src/lib.rs2
2 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 14a5e56cdea..cf3b3e1ffdd 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,15 @@ We have a bunch of lint categories to allow you to choose how much Clippy is sup
 
 More to come, please [file an issue](https://github.com/rust-lang-nursery/rust-clippy/issues) if you have ideas!
 
+Only the following of those categories are enabled by default:
+
+* `clippy::style`
+* `clippy::correctness`
+* `clippy::complexity`
+* `clippy::perf`
+
+Other categories need to be enabled in order for their lints to be executed.
+
 Table of contents:
 
 *   [Usage instructions](#usage)
diff --git a/clippy_lints/src/lib.rs b/clippy_lints/src/lib.rs
index c343cf364f6..7cdc0f43b34 100644
--- a/clippy_lints/src/lib.rs
+++ b/clippy_lints/src/lib.rs
@@ -46,6 +46,8 @@ extern crate syntax_pos;
 
 use toml;
 
+// Currently, categories "style", "correctness", "complexity" and "perf" are enabled by default,
+// as said in the README.md of this repository. If this changes, please update README.md.
 macro_rules! declare_clippy_lint {
     { pub $name:tt, style, $description:tt } => {
         declare_tool_lint! { pub clippy::$name, Warn, $description, report_in_external_macro: true }