summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2021-12-27 20:43:48 +0000
committerbors <bors@rust-lang.org>2021-12-27 20:43:48 +0000
commitc749b2d393b6914e4e9610e6df0d82a7271cfea9 (patch)
treeaa7938773203f048ec17381c2fc37bf9d1161e46
parent547efad9454123b5d37e627eb8643666aa3ddf3b (diff)
downloadrust-c749b2d393b6914e4e9610e6df0d82a7271cfea9.tar.gz
Readme: note that config changes don't apply to already compiled code
*Please write a short comment explaining your change (or "none" for internal only changes)* changelog: added a note to the Readme that config changes don't apply to already compiled code
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 73b0167d363..ce277d56b94 100644
--- a/README.md
+++ b/README.md
@@ -155,6 +155,10 @@ cognitive-complexity-threshold = 30
See the [list of lints](https://rust-lang.github.io/rust-clippy/master/index.html) for more information about which
lints can be configured and the meaning of the variables.
+Note that configuration changes will not apply for code that has already been compiled and cached under `./target/`;
+for example, adding a new string to `doc-valid-idents` may still result in Clippy flagging that string. To be sure that
+any configuration changes are applied, you may want to run `cargo clean` and re-compile your crate from scratch.
+
To deactivate the “for further information visit *lint-link*” message you can
define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.