summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/lintcheck/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/clippy/lintcheck/README.md')
-rw-r--r--src/tools/clippy/lintcheck/README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/tools/clippy/lintcheck/README.md b/src/tools/clippy/lintcheck/README.md
index 6142de5e3..faf3ce909 100644
--- a/src/tools/clippy/lintcheck/README.md
+++ b/src/tools/clippy/lintcheck/README.md
@@ -16,7 +16,7 @@ or
cargo lintcheck
```
-By default the logs will be saved into
+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
@@ -25,6 +25,15 @@ the repo root.
The results will then be saved to `lintcheck-logs/custom_logs.toml`.
+The `custom.toml` file may be built using <https://crates.io> recently most
+downloaded crates by using the `popular-crates` binary from the `lintcheck`
+directory. For example, to retrieve the 100 recently most downloaded crates:
+
+```
+cargo run --release --bin popular-crates -- -n 100 custom.toml
+```
+
+
### Configuring the Crate Sources
The sources to check are saved in a `toml` file. There are three types of