Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-11-30 08:30:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

Auto merge of #10712 - blyxyas:fix-fixflag_implies_all_targets, r=llogiq

Browse source 
Document that `cargo clippy --fix` implies `--all-targets`

In [`cargo fix`'s documentation](https://doc.rust-lang.org/cargo/commands/cargo-fix.html) they indicate that `fix` implies `--all-targets` if no target is supplied. As Clippy uses Cargo under the hood, this also applies to Clippy, but we didn't document that behaviour.

This PR changes that

Fixes #10690
changelog: Add to documentation that `--fix` implies `--all-targets`
This commit is contained in:
bors 2023-04-25 17:11:52 +00:00
commit a7335cbf90
4 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -91,7 +91,8 @@ cargo clippy
#### Automatically applying Clippy suggestions #### Automatically applying Clippy suggestions
Clippy can automatically apply some lint suggestions, just like the compiler. Clippy can automatically apply some lint suggestions, just like the compiler. Note that `--fix` implies
`--all-targets`, so it can fix as much code as it can.
```terminal ```terminal
cargo clippy --fix cargo clippy --fix

3
book/src/usage.md
View file

@ -111,7 +111,8 @@ fn main() {
### Automatically applying Clippy suggestions ### Automatically applying Clippy suggestions
Clippy can automatically apply some lint suggestions, just like the compiler. Clippy can automatically apply some lint suggestions, just like the compiler. Note that `--fix` implies
`--all-targets`, so it can fix as much code as it can.
```terminal ```terminal
cargo clippy --fix cargo clippy --fix

4
lintcheck/README.md
View file

@ -79,9 +79,11 @@ is explicitly specified in the options.
### Fix mode ### Fix mode
You can run `cargo lintcheck --fix` which will run Clippy with `--fix` and You can run `cargo lintcheck --fix` which will run Clippy with `--fix` and
print a warning if Clippy's suggestions fail to apply (if the resulting code does not build). print a warning if Clippy's suggestions fail to apply (if the resulting code does not build).
This lets us spot bad suggestions or false positives automatically in some cases. This lets us spot bad suggestions or false positives automatically in some cases.
> Note: Fix mode implies `--all-targets`, so it can fix as much code as it can.
Please note that the target dir should be cleaned afterwards since clippy will modify Please note that the target dir should be cleaned afterwards since clippy will modify
the downloaded sources which can lead to unexpected results when running lintcheck again afterwards. the downloaded sources which can lead to unexpected results when running lintcheck again afterwards.

2
src/main.rs
View file

@ -13,7 +13,7 @@ Usage:
Common options: Common options:
--no-deps Run Clippy only on the given crate, without linting the dependencies --no-deps Run Clippy only on the given crate, without linting the dependencies
--fix Automatically apply lint suggestions. This flag implies `--no-deps` --fix Automatically apply lint suggestions. This flag implies `--no-deps` and `--all-targets`
-h, --help Print this message -h, --help Print this message
-V, --version Print version info and exit -V, --version Print version info and exit
--explain LINT Print the documentation for a given lint --explain LINT Print the documentation for a given lint