about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--clippy_dev/README.md77
-rw-r--r--lintcheck/Cargo.toml2
-rw-r--r--lintcheck/README.md16
3 files changed, 5 insertions, 90 deletions
diff --git a/clippy_dev/README.md b/clippy_dev/README.md
deleted file mode 100644
index a5ed9e27bd2..00000000000
--- a/clippy_dev/README.md
+++ /dev/null
@@ -1,77 +0,0 @@
-# Clippy Dev Tool
-
-The Clippy Dev Tool is a tool to ease Clippy development, similar to `rustc`s
-`x.py`.
-
-Functionalities (incomplete):
-
-## `lintcheck`
-
-Runs clippy on a fixed set of crates read from
-`clippy_dev/lintcheck_crates.toml` and saves logs of the lint warnings into the
-repo.  We can then check the diff and spot new or disappearing warnings.
-
-From the repo root, run:
-
-```
-cargo run --target-dir clippy_dev/target --package clippy_dev \
---bin clippy_dev --manifest-path clippy_dev/Cargo.toml --features lintcheck -- lintcheck
-```
-
-or
-
-```
-cargo dev-lintcheck
-```
-
-By default the logs will be saved into
-`lintcheck-logs/lintcheck_crates_logs.txt`.
-
-You can set a custom sources.toml by adding `--crates-toml custom.toml` or using
-`LINTCHECK_TOML="custom.toml"` where `custom.toml` must be a relative path from
-the repo root.
-
-The results will then be saved to `lintcheck-logs/custom_logs.toml`.
-
-### Configuring the Crate Sources
-
-The sources to check are saved in a `toml` file. There are three types of
-sources.
-
-1. Crates-io Source
-
-   ```toml
-   bitflags = {name = "bitflags", versions = ['1.2.1']}
-   ```
-   Requires a "name" and one or multiple "versions" to be checked.
-
-2. `git` Source
-   ````toml
-   puffin = {name = "puffin", git_url = "https://github.com/EmbarkStudios/puffin", git_hash = "02dd4a3"}
-   ````
-   Requires a name, the url to the repo and unique identifier of a commit,
-   branch or tag which is checked out before linting.  There is no way to always
-   check `HEAD` because that would lead to changing lint-results as the repo
-   would get updated.  If `git_url` or `git_hash` is missing, an error will be
-   thrown.
-
-3. Local Dependency
-   ```toml
-   clippy = {name = "clippy", path = "/home/user/clippy"}
-   ```
-   For when you want to add a repository that is not published yet.
-
-#### Command Line Options (optional)
-
-```toml
-bitflags = {name = "bitflags", versions = ['1.2.1'], options = ['-Wclippy::pedantic', '-Wclippy::cargo']}
-```
-
-It is possible to specify command line options for each crate. This makes it
-possible to only check a crate for certain lint groups. If no options are
-specified, the lint groups `clippy::all`, `clippy::pedantic`, and
-`clippy::cargo` are checked. If an empty array is specified only `clippy::all`
-is checked.
-
-**Note:** `-Wclippy::all` is always enabled by default, unless `-Aclippy::all`
-is explicitly specified in the options.
diff --git a/lintcheck/Cargo.toml b/lintcheck/Cargo.toml
index 071c1f89615..5eb9e4aacae 100644
--- a/lintcheck/Cargo.toml
+++ b/lintcheck/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "lintcheck"
 version = "0.0.1"
-authors = ["Matthias Krüger <matthias.krueger@famsik.de>"]
+authors = ["The Rust Clippy Developers"]
 edition = "2018"
 
 [dependencies]
diff --git a/lintcheck/README.md b/lintcheck/README.md
index a5ed9e27bd2..68dbf564014 100644
--- a/lintcheck/README.md
+++ b/lintcheck/README.md
@@ -1,27 +1,19 @@
-# Clippy Dev Tool
-
-The Clippy Dev Tool is a tool to ease Clippy development, similar to `rustc`s
-`x.py`.
-
-Functionalities (incomplete):
-
-## `lintcheck`
+## `cargo lintcheck`
 
 Runs clippy on a fixed set of crates read from
-`clippy_dev/lintcheck_crates.toml` and saves logs of the lint warnings into the
+`lintcheck/lintcheck_crates.toml` and saves logs of the lint warnings into the
 repo.  We can then check the diff and spot new or disappearing warnings.
 
 From the repo root, run:
 
 ```
-cargo run --target-dir clippy_dev/target --package clippy_dev \
---bin clippy_dev --manifest-path clippy_dev/Cargo.toml --features lintcheck -- lintcheck
+cargo run --target-dir lintcheck/target --manifest-path lintcheck/Cargo.toml
 ```
 
 or
 
 ```
-cargo dev-lintcheck
+cargo lintcheck
 ```
 
 By default the logs will be saved into