X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=doc%2Fbasics.md;h=c56e84e2e32a22569c954c869506e56a0787b71d;hb=1a206fc4abae0b57a3f393481367cf3efca23586;hp=57f83bdf32bc2bb748a72f6cacf7d7017d59e09d;hpb=9607b5c6ac2d6b3d2117c8d5868435581c5e67d1;p=rust.git diff --git a/doc/basics.md b/doc/basics.md index 57f83bdf32b..c56e84e2e32 100644 --- a/doc/basics.md +++ b/doc/basics.md @@ -11,8 +11,9 @@ the codebase take a look at [Adding Lints] or [Common Tools]. - [Get the Code](#get-the-code) - [Building and Testing](#building-and-testing) - [`cargo dev`](#cargo-dev) - - [Common Abbreviations](#common-abbreviations) + - [lintcheck](#lintcheck) - [PR](#pr) + - [Common Abbreviations](#common-abbreviations) ## Get the Code @@ -91,6 +92,16 @@ cargo dev new_lint cargo dev ra_setup ``` +## lintcheck +`cargo lintcheck` will build and run clippy on a fixed set of crates and generate a log of the results. +You can `git diff` the updated log against its previous version and +see what impact your lint made on a small set of crates. +If you add a new lint, please audit the resulting warnings and make sure +there are no false positives and that the suggestions are valid. + +Refer to the tools [README] for more details. + +[README]: https://github.com/rust-lang/rust-clippy/blob/master/lintcheck/README.md ## PR We follow a rustc no merge-commit policy. @@ -109,7 +120,7 @@ See . | HIR | High-Level Intermediate Representation | | TCX | Type context | -This is a concise list of abbreviations that can come up during clippy development. An extensive +This is a concise list of abbreviations that can come up during Clippy development. An extensive general list can be found in the [rustc-dev-guide glossary][glossary]. Always feel free to ask if an abbreviation or meaning is unclear to you.