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

start a clippy-dev readme and some rough info on how to use lintcheck

Browse source
This commit is contained in:
Matthias Krüger 2021-02-09 16:58:39 +01:00
parent c7241b6e5e
commit cfe154be8c
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
clippy_dev/README.md Normal file
View file

@ -0,0 +1,26 @@
## Clippy-dev is a tool to ease clippys development, similar to `rustc`s `x.py`.
Functionalities (incomplete):
# lintcheck
Runs clippy on a fixed set of crates read from `clippy_dev/lintcheck_crates.toml`
and saves logs of the lint warnings into the repo.
We can then check the diff and spot new or disappearing warnings.
From the repo root, run:
````
cargo run --target-dir clippy_dev/target --package clippy_dev \
--bin clippy_dev --manifest-path clippy_dev/Cargo.toml --features lintcheck -- lintcheck
````
or
````
cargo dev-lintcheck
````
By default the logs will be saved into `lintcheck-logs/lintcheck_crates_logs.txt`.
You can set a custom sources.toml by adding `--crates-toml custom.toml`
where `custom.toml` must be a relative path from the repo root.
The results will then be saved to `lintcheck-logs/custom_logs.toml`.