aboutsummaryrefslogtreecommitdiff
path: root/test/lint
diff options
context:
space:
mode:
authorFabian Jahr <fjahr@protonmail.com>2024-03-02 21:26:48 +0100
committerFabian Jahr <fjahr@protonmail.com>2024-03-17 21:24:02 +0100
commitfad7f423249c161cad20a754653f9477e2b98339 (patch)
treeedd13e09c49ad6531dcc883b9cd85ceb02af74be /test/lint
parent015ac13dcc964a31ef06dfdb565f88f901607f0e (diff)
downloadbitcoin-fad7f423249c161cad20a754653f9477e2b98339.tar.xz
lint: Clarify lint runner rust dependency
Diffstat (limited to 'test/lint')
-rw-r--r--test/lint/README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/test/lint/README.md b/test/lint/README.md
index 9cb61b484c..83264de06e 100644
--- a/test/lint/README.md
+++ b/test/lint/README.md
@@ -16,7 +16,11 @@ result is cached and it prevents issues when the image changes.
test runner
===========
-To run all the lint checks in the test runner outside the docker, use:
+To run all the lint checks in the test runner outside the docker you first need
+to install the rust toolchain using your package manager of choice or
+[rustup](https://www.rust-lang.org/tools/install).
+
+Then you can use:
```sh
( cd ./test/lint/test_runner/ && cargo fmt && cargo clippy && RUST_BACKTRACE=1 cargo run )