Skip to content

Commit d95d651

Browse files
committed
Consistently call it "Clippy", not clippy or rust-clippy
As per discussion on the Clippy 1.0 RFC
1 parent 6c70013 commit d95d651

File tree

5 files changed

+25
-25
lines changed

5 files changed

+25
-25
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to rust-clippy
1+
# Contributing to Clippy
22

33
Hello fellow Rustacean! Great to see your interest in compiler internals and lints!
44

@@ -63,7 +63,7 @@ an AST expression). `match_def_path()` in Clippy's `utils` module can also be us
6363

6464
## Writing code
6565

66-
Compiling clippy from scratch can take almost a minute or more depending on your machine.
66+
Compiling Clippy from scratch can take almost a minute or more depending on your machine.
6767
However, since Rust 1.24.0 incremental compilation is enabled by default and compile times for small changes should be quick.
6868

6969
[Llogiq's blog post on lints](https://llogiq.github.io/2015/06/04/workflows.html) is a nice primer
@@ -74,7 +74,7 @@ of this.
7474

7575
### Author lint
7676

77-
There is also the internal `author` lint to generate clippy code that detects the offending pattern. It does not work for all of the Rust syntax, but can give a good starting point.
77+
There is also the internal `author` lint to generate Clippy code that detects the offending pattern. It does not work for all of the Rust syntax, but can give a good starting point.
7878

7979
First, create a new UI test file in the `tests/ui/` directory with the pattern you want to match:
8080

@@ -148,7 +148,7 @@ Therefore you should use `tests/ui/update-all-references.sh` (after running
148148
### Testing manually
149149

150150
Manually testing against an example file is useful if you have added some
151-
`println!`s and test suite output becomes unreadable. To try clippy with your
151+
`println!`s and test suite output becomes unreadable. To try Clippy with your
152152
local modifications, run `cargo run --bin clippy-driver -- -L ./target/debug input.rs` from the
153153
working copy root.
154154

PUBLISH.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Steps to publish a new clippy version
1+
Steps to publish a new Clippy version
22

33
- Bump `package.version` in `./Cargo.toml` (no need to manually bump `dependencies.clippy_lints.version`).
44
- Write a changelog entry.

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
We are currently in the process of discussing Clippy 1.0 via the RFC process in https://github.com/rust-lang/rfcs/pull/2476 . The RFC's goal is to clarify policies around lint categorizations and the policy around which lints should be in the compiler and which lints should be in clippy. Please leave your thoughts on the RFC PR.
1+
We are currently in the process of discussing Clippy 1.0 via the RFC process in https://github.com/rust-lang/rfcs/pull/2476 . The RFC's goal is to clarify policies around lint categorizations and the policy around which lints should be in the compiler and which lints should be in Clippy. Please leave your thoughts on the RFC PR.
22

3-
# rust-clippy
3+
# Clippy
44

55
[![Build Status](https://travis-ci.org/rust-lang-nursery/rust-clippy.svg?branch=master)](https://travis-ci.org/rust-lang-nursery/rust-clippy)
66
[![Windows Build status](https://ci.appveyor.com/api/projects/status/id677xpw1dguo7iw?svg=true)](https://ci.appveyor.com/project/rust-lang-libs/rust-clippy)
@@ -11,7 +11,7 @@ A collection of lints to catch common mistakes and improve your [Rust](https://g
1111

1212
[There are 273 lints included in this crate!](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
1313

14-
We have a bunch of lint categories to allow you to choose how much clippy is supposed to ~~annoy~~ help you:
14+
We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you:
1515

1616
* `clippy` (everything that has no false positives)
1717
* `clippy_pedantic` (everything)
@@ -33,11 +33,11 @@ Table of contents:
3333
## Usage
3434

3535
Since this is a tool for helping the developer of a library or application
36-
write better code, it is recommended not to include clippy as a hard dependency.
36+
write better code, it is recommended not to include Clippy as a hard dependency.
3737
Options include using it as an optional dependency, as a cargo subcommand, or
3838
as an included feature during build. All of these options are detailed below.
3939

40-
As a general rule clippy will only work with the *latest* Rust nightly for now.
40+
As a general rule Clippy will only work with the *latest* Rust nightly for now.
4141

4242
To install Rust nightly, the recommended way is to use [rustup](https://rustup.rs/):
4343

@@ -47,7 +47,7 @@ rustup install nightly
4747

4848
### As a cargo subcommand (`cargo clippy`)
4949

50-
One way to use clippy is by installing clippy through cargo as a cargo
50+
One way to use Clippy is by installing Clippy through cargo as a cargo
5151
subcommand.
5252

5353
```terminal
@@ -56,7 +56,7 @@ cargo +nightly install clippy
5656

5757
(The `+nightly` is not necessary if your default `rustup` install is nightly)
5858

59-
Now you can run clippy by invoking `cargo +nightly clippy`.
59+
Now you can run Clippy by invoking `cargo +nightly clippy`.
6060

6161
To update the subcommand together with the latest nightly use the [rust-update](rust-update) script or run:
6262

@@ -66,24 +66,24 @@ cargo +nightly install --force clippy
6666
```
6767

6868
In case you are not using rustup, you need to set the environment flag
69-
`SYSROOT` during installation so clippy knows where to find `librustc` and
69+
`SYSROOT` during installation so Clippy knows where to find `librustc` and
7070
similar crates.
7171

7272
```terminal
7373
SYSROOT=/path/to/rustc/sysroot cargo install clippy
7474
```
7575

76-
### Running clippy from the command line without installing it
76+
### Running Clippy from the command line without installing it
7777

78-
To have cargo compile your crate with clippy without clippy installation
78+
To have cargo compile your crate with Clippy without Clippy installation
7979
in your code, you can use:
8080

8181
```terminal
8282
cargo run --bin cargo-clippy --manifest-path=path_to_clippys_Cargo.toml
8383
```
8484

8585
*[Note](https://github.com/rust-lang-nursery/rust-clippy/wiki#a-word-of-warning):*
86-
Be sure that clippy was compiled with the same version of rustc that cargo invokes here!
86+
Be sure that Clippy was compiled with the same version of rustc that cargo invokes here!
8787

8888
## Configuration
8989

@@ -117,7 +117,7 @@ You can add options to `allow`/`warn`/`deny`:
117117
Note: `deny` produces errors instead of warnings.
118118

119119
For convenience, `cargo clippy` automatically defines a `cargo-clippy`
120-
feature. This lets you set lint levels and compile with or without clippy
120+
feature. This lets you set lint levels and compile with or without Clippy
121121
transparently:
122122

123123
```rust
@@ -126,12 +126,12 @@ transparently:
126126

127127
## Updating rustc
128128

129-
Sometimes, rustc moves forward without clippy catching up. Therefore updating
130-
rustc may leave clippy a non-functional state until we fix the resulting
129+
Sometimes, rustc moves forward without Clippy catching up. Therefore updating
130+
rustc may leave Clippy a non-functional state until we fix the resulting
131131
breakage.
132132

133133
You can use the [rust-update](rust-update) script to update rustc only if
134-
clippy would also update correctly.
134+
Clippy would also update correctly.
135135

136136
## License
137137

build.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
//! This build script ensures that clippy is not compiled with an
1+
//! This build script ensures that Clippy is not compiled with an
22
//! incompatible version of rust. It will panic with a descriptive
33
//! error message instead.
44
//!
5-
//! We specifially want to ensure that clippy is only built with a
5+
//! We specifially want to ensure that Clippy is only built with a
66
//! rustc version that is newer or equal to the one specified in the
77
//! `min_version.txt` file.
88
//!
@@ -63,7 +63,7 @@ fn check_rustc_version() {
6363
eprintln!(
6464
"\n{} {}",
6565
Red.bold().paint("error:"),
66-
"clippy requires a nightly version of Rust."
66+
"Clippy requires a nightly version of Rust."
6767
);
6868
print_version_err(&current_version, &*current_date_str);
6969
eprintln!(
@@ -80,7 +80,7 @@ fn check_rustc_version() {
8080
eprintln!(
8181
"\n{} {}",
8282
Red.bold().paint("error:"),
83-
"clippy does not support this version of rustc nightly."
83+
"Clippy does not support this version of rustc nightly."
8484
);
8585
eprintln!(
8686
"> {}{}{}",

util/lintlib.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def parse_lints(lints, filepath):
4444
last_comment.append(line[3:])
4545
elif line.startswith("declare_lint!"):
4646
import sys
47-
print "don't use `declare_lint!` in clippy, use `declare_clippy_lint!` instead"
47+
print "don't use `declare_lint!` in Clippy, use `declare_clippy_lint!` instead"
4848
sys.exit(42)
4949
elif line.startswith("declare_clippy_lint!"):
5050
comment = False

0 commit comments

Comments
 (0)