Skip to content

Commit 22a5881

Browse files
author
MarcoFalke
committed
Merge #17353: doc: Add ShellCheck to lint tests dependencies
80c9e66 build: Remove install command samples (Hennadii Stepanov) 2ad74b7 doc: Add ShellCheck to lint tests dependencies (Hennadii Stepanov) Pull request description: In master (9641366) the lint tests dependencies list lacks ShellCheck. This PR fixes it. Also `lint-python.sh` is slightly improved. ACKs for top commit: laanwj: ACK 80c9e66 promag: ACK 80c9e66, verified internal and external links. Nice looking table. Tree-SHA512: b63718a6c41be93137db70586465d84ca0b1ff33c0f2674147c928cb1bdf903ec7587861c09ad832841264285f99c7b171d5319eef3c989822a7cd01449222ae
2 parents 7967104 + 80c9e66 commit 22a5881

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

test/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,13 @@ Use the `-v` option for verbose output.
254254

255255
#### Dependencies
256256

257-
The lint tests require codespell and flake8. To install: `pip3 install codespell flake8`.
257+
| Lint test | Dependency | Version [used by CI](../ci/lint/04_install.sh) | Installation
258+
|-----------|:----------:|:-------------------------------------------:|--------------
259+
| [`lint-python.sh`](lint/lint-python.sh) | [flake8](https://gitlab.com/pycqa/flake8) | [3.7.8](https://github.com/bitcoin/bitcoin/pull/15257) | `pip3 install flake8==3.7.8`
260+
| [`lint-shell.sh`](lint/lint-shell.sh) | [ShellCheck](https://github.com/koalaman/shellcheck) | [0.6.0](https://github.com/bitcoin/bitcoin/pull/15166) | [details...](https://github.com/koalaman/shellcheck#installing)
261+
| [`lint-spelling.sh`](lint/lint-spelling.sh) | [codespell](https://github.com/codespell-project/codespell) | [1.15.0](https://github.com/bitcoin/bitcoin/pull/16186) | `pip3 install codespell==1.15.0`
262+
263+
Please be aware that on Linux distributions all dependencies are usually available as packages, but could be outdated.
258264

259265
#### Running the tests
260266

test/lint/lint-python.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ enabled=(
8282
)
8383

8484
if ! command -v flake8 > /dev/null; then
85-
echo "Skipping Python linting since flake8 is not installed. Install by running \"pip3 install flake8\""
85+
echo "Skipping Python linting since flake8 is not installed."
8686
exit 0
8787
elif PYTHONWARNINGS="ignore" flake8 --version | grep -q "Python 2"; then
88-
echo "Skipping Python linting since flake8 is running under Python 2. Install the Python 3 version of flake8 by running \"pip3 install flake8\""
88+
echo "Skipping Python linting since flake8 is running under Python 2. Install the Python 3 version of flake8."
8989
exit 0
9090
fi
9191

0 commit comments

Comments
 (0)