@@ -36,6 +36,7 @@ Table of contents:
36
36
37
37
* [ Usage instructions] ( #usage )
38
38
* [ Configuration] ( #configuration )
39
+ * [ Contributing] ( #contributing )
39
40
* [ License] ( #license )
40
41
41
42
## Usage
@@ -52,7 +53,7 @@ subcommand.
52
53
53
54
#### Step 1: Install rustup
54
55
55
- You can install [ rustup] ( http ://rustup.rs/) on supported platforms. This will help
56
+ You can install [ rustup] ( https ://rustup.rs/) on supported platforms. This will help
56
57
us install Clippy and its dependencies.
57
58
58
59
If you already have rustup installed, update to ensure you have the latest
@@ -88,8 +89,7 @@ in your code, you can use:
88
89
cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
89
90
```
90
91
91
- * [ Note] ( https://github.com/rust-lang/rust-clippy/wiki#a-word-of-warning ) :*
92
- Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
92
+ * Note:* Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
93
93
94
94
### Travis CI
95
95
@@ -113,20 +113,20 @@ script:
113
113
```
114
114
115
115
If you are on nightly, It might happen that Clippy is not available for a certain nightly release.
116
- In this case you can try to conditionally install Clippy from the git repo.
116
+ In this case you can try to conditionally install Clippy from the Git repo.
117
117
118
118
``` yaml
119
119
language : rust
120
120
rust :
121
121
- nightly
122
122
before_script :
123
123
- rustup component add clippy --toolchain=nightly || cargo install --git https://github.com/rust-lang/rust-clippy/ --force clippy
124
- # etc
124
+ # etc.
125
125
```
126
126
127
127
Note that adding ` -D warnings ` will cause your build to fail if ** any** warnings are found in your code.
128
128
That includes warnings found by rustc (e.g. ` dead_code ` , etc.). If you want to avoid this and only cause
129
- an error for clippy warnings, use ` #![deny(clippy::all)] ` in your code or ` -D clippy::all ` on the command
129
+ an error for Clippy warnings, use ` #![deny(clippy::all)] ` in your code or ` -D clippy::all ` on the command
130
130
line. (You can swap ` clippy::all ` with the specific lint category you are targeting.)
131
131
132
132
## Configuration
@@ -154,9 +154,9 @@ You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
154
154
` #![deny(clippy::pedantic)] ` ). Note that ` clippy::pedantic ` contains some very aggressive
155
155
lints prone to false positives.
156
156
157
- * only some lints (` #![deny(clippy::single_match, clippy::box_vec)] ` , etc)
157
+ * only some lints (` #![deny(clippy::single_match, clippy::box_vec)] ` , etc. )
158
158
159
- * ` allow ` /` warn ` /` deny ` can be limited to a single function or module using ` #[allow(...)] ` , etc
159
+ * ` allow ` /` warn ` /` deny ` can be limited to a single function or module using ` #[allow(...)] ` , etc.
160
160
161
161
Note: ` deny ` produces errors instead of warnings.
162
162
@@ -171,7 +171,7 @@ If you want to contribute to Clippy, you can find more information in [CONTRIBUT
171
171
Copyright 2014-2019 The Rust Project Developers
172
172
173
173
Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
174
- [ http ://www.apache.org/licenses/LICENSE-2.0] ( http://www.apache.org/licenses/LICENSE-2.0 ) > or the MIT license
175
- <LICENSE-MIT or [ http ://opensource.org/licenses/MIT] ( http://opensource.org/licenses/MIT ) >, at your
174
+ [ https ://www.apache.org/licenses/LICENSE-2.0] ( http://www.apache.org/licenses/LICENSE-2.0 ) > or the MIT license
175
+ <LICENSE-MIT or [ https ://opensource.org/licenses/MIT] ( http://opensource.org/licenses/MIT ) >, at your
176
176
option. All files in the project carrying such notice may not be
177
177
copied, modified, or distributed except according to those terms.
0 commit comments