about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMarcusGrass <marcus.grass@protonmail.com>2023-06-01 12:14:55 +0200
committerMarcusGrass <marcus.grass@protonmail.com>2023-06-01 12:14:55 +0200
commit5f5e2e2ac137b19f2f2a21562ca34a6edb1a7d8f (patch)
tree901deeed5c735acddad9b7b8a378ec1420cbb1e0
parent652b4c720dd613270f4755c39fa77d4d686187be (diff)
downloadrust-5f5e2e2ac137b19f2f2a21562ca34a6edb1a7d8f.tar.gz
rust-5f5e2e2ac137b19f2f2a21562ca34a6edb1a7d8f.zip
Explain which paths clippy searches for configuration in docs
-rw-r--r--book/src/configuration.md6
-rw-r--r--book/src/development/adding_lints.md6
-rw-r--r--clippy_lints/src/utils/conf.rs2
3 files changed, 9 insertions, 5 deletions
diff --git a/book/src/configuration.md b/book/src/configuration.md
index 1304f6a8c2f..54af30d17e1 100644
--- a/book/src/configuration.md
+++ b/book/src/configuration.md
@@ -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
diff --git a/book/src/development/adding_lints.md b/book/src/development/adding_lints.md
index ccae8d37420..ea3819ccbdf 100644
--- a/book/src/development/adding_lints.md
+++ b/book/src/development/adding_lints.md
@@ -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:
 
diff --git a/clippy_lints/src/utils/conf.rs b/clippy_lints/src/utils/conf.rs
index f6de66bb514..4acff7fd322 100644
--- a/clippy_lints/src/utils/conf.rs
+++ b/clippy_lints/src/utils/conf.rs
@@ -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)