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

Explain which paths clippy searches for configuration in docs

Browse source
This commit is contained in:
MarcusGrass 2023-06-01 12:14:55 +02:00
parent 652b4c720d
commit 5f5e2e2ac1
No known key found for this signature in database
GPG key ID: B3F995FE064E3AA9
3 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
book/src/configuration.md
View file

@ -2,8 +2,10 @@
> **Note:** The configuration file is unstable and may be deprecated in the future.
Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a
basic `variable = value` mapping e.g.
Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`, placed in a directory specified by
the environment variable `CLIPPY_CONF_DIR`, or if that's not found, the environment variable
[CARGO_MANIFEST_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html), or if that isn't
found, the current directory. It contains a basic `variable = value` mapping e.g.
```toml
avoid-breaking-exported-api = false

6
book/src/development/adding_lints.md
View file

@ -630,8 +630,10 @@ Before submitting your PR make sure you followed all the basic requirements:
## Adding configuration to a lint
Clippy supports the configuration of lints values using a `clippy.toml` file in
the workspace directory. Adding a configuration to a lint can be useful for
Clippy supports the configuration of lints values using a `clippy.toml` file in a directory specified by
the environment variable `CLIPPY_CONF_DIR`, or if that's not found, the environment variable
[CARGO_MANIFEST_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html), or if that isn't
found, the current directory. Adding a configuration to a lint can be useful for
thresholds or to constrain some behavior that can be seen as a false positive
for some users. Adding a configuration is done in the following steps:

2
clippy_lints/src/utils/conf.rs
View file

@ -486,7 +486,7 @@ pub fn lookup_conf_file() -> io::Result<(Option<PathBuf>, Vec<String>)> {
const CONFIG_FILE_NAMES: [&str; 2] = [".clippy.toml", "clippy.toml"];
// Start looking for a config file in CLIPPY_CONF_DIR, or failing that, CARGO_MANIFEST_DIR.
// If neither of those exist, use ".".
// If neither of those exist, use ".". (Update documentation if this priority changes)
let mut current = env::var_os("CLIPPY_CONF_DIR")
.or_else(|| env::var_os("CARGO_MANIFEST_DIR"))
.map_or_else(|| PathBuf::from("."), PathBuf::from)