Auto merge of #6782 - ojeda:readme-as-wrapper, r=flip1995
README: Add subsection on running Clippy as a rustc wrapper This is useful for projects that do not use cargo. changelog: README: Add subsection on running Clippy as a rustc wrapper
This commit is contained in:
commit
045d3f34f8
17
README.md
17
README.md
@ -98,6 +98,23 @@ If you want to run Clippy **only** on the given crate, use the `--no-deps` optio
|
|||||||
cargo clippy -p example -- --no-deps
|
cargo clippy -p example -- --no-deps
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### As a rustc replacement (`clippy-driver`)
|
||||||
|
|
||||||
|
Clippy can also be used in projects that do not use cargo. To do so, you will need to replace
|
||||||
|
your `rustc` compilation commands with `clippy-driver`. For example, if your project runs:
|
||||||
|
|
||||||
|
```terminal
|
||||||
|
rustc --edition 2018 -Cpanic=abort foo.rs
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, to enable Clippy, you will need to call:
|
||||||
|
|
||||||
|
```terminal
|
||||||
|
clippy-driver --edition 2018 -Cpanic=abort foo.rs
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that `rustc` will still run, i.e. it will still emit the output files it normally does.
|
||||||
|
|
||||||
### Travis CI
|
### Travis CI
|
||||||
|
|
||||||
You can add Clippy to Travis CI in the same way you use it locally:
|
You can add Clippy to Travis CI in the same way you use it locally:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user