Replace another occurrence of "".to_owned()

[rust.git] / README.md

diff --git a/README.md b/README.md
index 69dba57f4602579c56b667a43af0e6d08eb1150a..79cb35587f487faa953b4b5d01f7bb267cf60352 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ We are currently in the process of discussing Clippy 1.0 via the RFC process in
 
 A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.
 
-[There are 273 lints included in this crate!](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
+[There are 275 lints included in this crate!](https://rust-lang-nursery.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:
 
@@ -45,7 +45,7 @@ subcommand.
 #### Step 1: Install rustup
 
 You can install [rustup](http://rustup.rs/) on supported platforms. This will help
-us install clippy and its dependencies.
+us install Clippy and its dependencies.
 
 If you already have rustup installed, update to ensure you have the latest
 rustup and compiler:
@@ -54,26 +54,15 @@ rustup and compiler:
 rustup update
 ```
 
-#### Step 2: Install nightly toolchain
+#### Step 2: Install Clippy
 
-Rustup integration is still new, you will need a relatively new nightly (2018-07-15 or later).
-
-To install Rust nightly with [rustup](https://rustup.rs/):
-
-```terminal
-rustup install nightly
-```
-
-#### Step 3: Install clippy
-
-Once you have rustup and the nightly toolchain installed, run the following command:
+Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:
 
 ```terminal
-rustup component add clippy-preview --toolchain=nightly
+rustup component add clippy-preview
 ```
 
-Now you can run Clippy by invoking `cargo +nightly clippy`. If nightly is your
-default toolchain in rustup, `cargo clippy` will work fine.
+Now you can run Clippy by invoking `cargo clippy`.
 
 ### Running Clippy from the command line without installing it
 
@@ -87,6 +76,25 @@ cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
 *[Note](https://github.com/rust-lang-nursery/rust-clippy/wiki#a-word-of-warning):*
 Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
 
+### Travis CI
+
+You can add Clippy to Travis CI in the same way you use it locally:
+
+```yml
+- rust: stable
+- rust: beta
+  before_script:
+    - rustup component add clippy-preview
+  script:
+    - cargo clippy
+# if you want the build job to fail when encountering warnings, use
+    - cargo clippy -- -D warnings
+# in order to also check tests and none-default crate features, use
+    - cargo clippy --all-targets --all-features -- -D warnings
+    - cargo test
+    # etc.
+```
+
 ## Configuration
 
 Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable = value` mapping eg.
@@ -104,7 +112,7 @@ define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
 
 ### Allowing/denying lints
 
-You can add options  to `allow`/`warn`/`deny`:
+You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
 
 *   the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`)
 
@@ -118,14 +126,20 @@ You can add options  to `allow`/`warn`/`deny`:
 
 Note: `deny` produces errors instead of warnings.
 
-## Updating rustc
-
-Sometimes, rustc moves forward without Clippy catching up. Therefore updating
-rustc may leave Clippy a non-functional state until we fix the resulting
-breakage.
+Note: To use the new `clippy::lint_name` syntax, `#![feature(tool_lints)]` has to be activated 
+currently. If you want to compile your code with the stable toolchain you can use a `cfg_attr` to 
+activate the `tool_lints` feature:
+```rust
+#![cfg_attr(feature = "cargo-clippy", feature(tool_lints))]
+#![cfg_attr(feature = "cargo-clippy", allow(clippy::lint_name))]
+```
 
-You can use the [rust-update](rust-update) script to update rustc only if
-Clippy would also update correctly.
+For this to work you have to use Clippy on the nightly toolchain: `cargo +nightly clippy`. If you 
+want to use Clippy with the stable toolchain, you can stick to the old unscoped method to 
+enable/disable Clippy lints until `tool_lints` are stable:
+```rust
+#![cfg_attr(feature = "cargo-clippy", allow(clippy_lint))]
+```
 
 ## License