Skip to content

Commit 93e74a4

Browse files
committed
Lintcheck: Update lintcheck documentation
1 parent 25bb612 commit 93e74a4

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

lintcheck/README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ repo. We can then check the diff and spot new or disappearing warnings.
77
From the repo root, run:
88

99
```
10-
cargo run --target-dir lintcheck/target --manifest-path lintcheck/Cargo.toml
10+
cargo lintcheck
1111
```
1212

1313
or
1414

1515
```
16-
cargo lintcheck
16+
cargo run --target-dir lintcheck/target --manifest-path lintcheck/Cargo.toml
1717
```
1818

1919
By default, the logs will be saved into
@@ -33,6 +33,8 @@ the 200 recently most downloaded crates:
3333
cargo lintcheck popular -n 200 custom.toml
3434
```
3535

36+
> Note: Lintcheck isn't sandboxed. Only use it to check crates that you trust or
37+
> sandbox it manually.
3638
3739
### Configuring the Crate Sources
3840

@@ -65,17 +67,11 @@ sources.
6567
#### Command Line Options (optional)
6668

6769
```toml
68-
bitflags = {name = "bitflags", versions = ['1.2.1'], options = ['-Wclippy::pedantic', '-Wclippy::cargo']}
70+
clap = {name = "clap", versions = ['4.5.8'], options = ['-Fderive']}
6971
```
7072

7173
It is possible to specify command line options for each crate. This makes it
72-
possible to only check a crate for certain lint groups. If no options are
73-
specified, the lint groups `clippy::all`, `clippy::pedantic`, and
74-
`clippy::cargo` are checked. If an empty array is specified only `clippy::all`
75-
is checked.
76-
77-
**Note:** `-Wclippy::all` is always enabled by default, unless `-Aclippy::all`
78-
is explicitly specified in the options.
74+
possible to enable or disable features.
7975

8076
### Fix mode
8177
You can run `cargo lintcheck --fix` which will run Clippy with `--fix` and

0 commit comments

Comments
 (0)