X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=62a8be0abf22c5a08743aa5e4092eaf612927bf6;hb=7f846c930b9d35061e6eb6b8dbfbc890d38d539c;hp=7d6fcbc90986ee68872b9398957983dbf06c6596;hpb=52208f3cf3949a4589cbaee69a9cb7d34ee0e9f2;p=rust.git diff --git a/README.md b/README.md index 7d6fcbc9098..62a8be0abf2 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code. -[There are 362 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html) +[There are over 400 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html) We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you: @@ -42,10 +42,8 @@ Table of contents: ## Usage -Since this is a tool for helping the developer of a library or application -write better code, it is recommended not to include Clippy as a hard dependency. -Options include using it as an optional dependency, as a cargo subcommand, or -as an included feature during build. These options are detailed below. +Below are instructions on how to use Clippy as a subcommand, compiled from source +or in Travis CI. ### As a cargo subcommand (`cargo clippy`) @@ -83,11 +81,11 @@ cargo clippy #### Automatically applying Clippy suggestions -Some Clippy lint suggestions can be automatically applied by `cargo fix`. +Clippy can automatically apply some lint suggestions. Note that this is still experimental and only supported on the nightly channel: ```terminal -cargo fix -Z unstable-options --clippy +cargo clippy --fix -Z unstable-options ``` ### Running Clippy from the command line without installing it @@ -175,6 +173,8 @@ If you do not want to include your lint levels in your code, you can globally en flags to Clippy during the run: `cargo clippy -- -A clippy::lint_name` will run Clippy with `lint_name` disabled and `cargo clippy -- -W clippy::lint_name` will run it with that enabled. This also works with lint groups. For example you can run Clippy with warnings for all lints enabled: `cargo clippy -- -W clippy::pedantic` +If you care only about a single lint, you can allow all others and then explicitly reenable +the lint(s) you are interested in: `cargo clippy -- -Aclippy::all -Wclippy::useless_format -Wclippy::...` ## Contributing