Auto merge of #6432 - giraffate:sync-from-rust, r=flip1995

[rust.git] / README.md

diff --git a/README.md b/README.md
index 080e887442717c3e6eb2802e2d584a9d1112ab1b..fddf0614a0b85d77b24dbb93c6463222e8d7bbce 100644 (file)
--- a/README.md
+++ b/README.md
@@ -147,30 +147,6 @@ lints can be configured and the meaning of the variables.
 To deactivate the “for further information visit *lint-link*” message you can
 define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 
-### Specifying the minimum supported Rust version
-
-Projects that intend to support old versions of Rust can disable lints pertaining to newer features by
-specifying the minimum supported Rust version (msrv) in the clippy configuration file.
-
-```toml
-msrv = "1.30.0"
-```
-
-The msrv can also be specified as an inner attribute, like below.
-
-```rust
-#![feature(custom_inner_attributes)]
-#![clippy::msrv = "1.30.0"]
-
-fn main() {
-  ...
-}
-```
-
-Tilde/Caret version requirements(like `^1.0` or `~1.2`) can be specified as well.
-
-Note: `custom_inner_attributes` is an unstable feature so it has to be enabled explicitly.
-
 ### Allowing/denying lints
 
 You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
@@ -206,7 +182,7 @@ cargo clippy -- -W clippy::lint_name
 ```
 
 This also works with lint groups. For example you
-can run Clippy with warnings for all lints enabled: 
+can run Clippy with warnings for all lints enabled:
 ```terminal
 cargo clippy -- -W clippy::pedantic
 ```
@@ -218,6 +194,33 @@ cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...
 ```
 Note that if you've run clippy before, this may only take effect after you've modified a file or ran `cargo clean`.
 
+### Specifying the minimum supported Rust version
+
+Projects that intend to support old versions of Rust can disable lints pertaining to newer features by
+specifying the minimum supported Rust version (MSRV) in the clippy configuration file.
+
+```toml
+msrv = "1.30.0"
+```
+
+The MSRV can also be specified as an inner attribute, like below.
+
+```rust
+#![feature(custom_inner_attributes)]
+#![clippy::msrv = "1.30.0"]
+
+fn main() {
+  ...
+}
+```
+
+You can also omit the patch version when specifying the MSRV, so `msrv = 1.30`
+is equivalent to `msrv = 1.30.0`.
+
+Note: `custom_inner_attributes` is an unstable feature so it has to be enabled explicitly.
+
+Lints that recognize this configuration option can be found [here](https://rust-lang.github.io/rust-clippy/master/index.html#msrv)
+
 ## Contributing
 
 If you want to contribute to Clippy, you can find more information in [CONTRIBUTING.md](https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md).