Skip to content

Commit 111e058

Browse files
committed
Adapting documentation
1 parent d6420ef commit 111e058

File tree

2 files changed

+13
-21
lines changed

2 files changed

+13
-21
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ pub fn register_plugins(reg: &mut rustc_plugin::Registry) {
170170
reg.register_early_lint_pass(box else_if_without_else::ElseIfWithoutElse);
171171
// ...
172172

173-
reg.register_lint_group("clippy_restriction", vec![
173+
reg.register_lint_group("clippy::restriction", vec![
174174
// ...
175175
else_if_without_else::ELSE_IF_WITHOUT_ELSE,
176176
// ...

README.md

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ A collection of lints to catch common mistakes and improve your [Rust](https://g
1313

1414
We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you:
1515

16-
* `clippy` (everything that has no false positives)
17-
* `clippy_pedantic` (everything)
18-
* `clippy_nursery` (new lints that aren't quite ready yet)
19-
* `clippy_style` (code that should be written in a more idiomatic way)
20-
* `clippy_complexity` (code that does something simple but in a complex way)
21-
* `clippy_perf` (code that can be written in a faster way)
22-
* `clippy_cargo` (checks against the cargo manifest)
23-
* **`clippy_correctness`** (code that is just outright wrong or very very useless)
16+
* `clippy::all` (everything that has no false positives)
17+
* `clippy::pedantic` (everything)
18+
* `clippy::nursery` (new lints that aren't quite ready yet)
19+
* `clippy::style` (code that should be written in a more idiomatic way)
20+
* `clippy::complexity` (code that does something simple but in a complex way)
21+
* `clippy::perf` (code that can be written in a faster way)
22+
* `clippy::cargo` (checks against the cargo manifest)
23+
* **`clippy::correctness`** (code that is just outright wrong or very very useless)
2424

2525
More to come, please [file an issue](https://github.com/rust-lang-nursery/rust-clippy/issues) if you have ideas!
2626

@@ -106,26 +106,18 @@ define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
106106

107107
You can add options to `allow`/`warn`/`deny`:
108108

109-
* the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy)]`)
109+
* the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`)
110110

111-
* all lints using both the `clippy` and `clippy_pedantic` lint groups (`#![deny(clippy)]`,
112-
`#![deny(clippy_pedantic)]`). Note that `clippy_pedantic` contains some very aggressive
111+
* all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
112+
`#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
113113
lints prone to false positives.
114114

115-
* only some lints (`#![deny(single_match, box_vec)]`, etc)
115+
* only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc)
116116

117117
* `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc
118118

119119
Note: `deny` produces errors instead of warnings.
120120

121-
For convenience, `cargo clippy` automatically defines a `cargo-clippy`
122-
feature. This lets you set lint levels and compile with or without Clippy
123-
transparently:
124-
125-
```rust
126-
#[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]
127-
```
128-
129121
## Updating rustc
130122

131123
Sometimes, rustc moves forward without Clippy catching up. Therefore updating

0 commit comments

Comments
 (0)