mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-19 05:45:05 +01:00
Code Issues Projects Releases Wiki Activity

doc: move-only lint docs to one place

Browse Source 
Can be reviewed with --color-moved=dimmed-zebra
This commit is contained in:
MarcoFalke 2024-01-16 10:53:48 +01:00
parent 2ac2821a74
commit fadb06c361
No known key found for this signature in database
2 changed files with 31 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
test/README.md
View File

@ -326,35 +326,7 @@ Use the `-v` option for verbose output.
### Lint tests ### Lint tests
#### Dependencies See the README in [test/lint](/test/lint).
| Lint test | Dependency |
|-----------|:----------:|
| [`lint-python.py`](lint/lint-python.py) | [flake8](https://gitlab.com/pycqa/flake8)
| [`lint-python.py`](lint/lint-python.py) | [lief](https://github.com/lief-project/LIEF)
| [`lint-python.py`](lint/lint-python.py) | [mypy](https://github.com/python/mypy)
| [`lint-python.py`](lint/lint-python.py) | [pyzmq](https://github.com/zeromq/pyzmq)
| [`lint-python-dead-code.py`](lint/lint-python-dead-code.py) | [vulture](https://github.com/jendrikseipp/vulture)
| [`lint-shell.py`](lint/lint-shell.py) | [ShellCheck](https://github.com/koalaman/shellcheck)
| [`lint-spelling.py`](lint/lint-spelling.py) | [codespell](https://github.com/codespell-project/codespell)
In use versions and install instructions are available in the [CI setup](../ci/lint/04_install.sh).
Please be aware that on Linux distributions all dependencies are usually available as packages, but could be outdated.
#### Running the tests
Individual tests can be run by directly calling the test script, e.g.:
```
test/lint/lint-files.py
```
You can run all the shell-based lint tests by running:
```
test/lint/all-lint.py
```
# Writing functional tests # Writing functional tests

30
test/lint/README.md
View File

@ -22,6 +22,36 @@ To run the checks in the test runner outside the docker, use:
( cd ./test/lint/test_runner/ && cargo fmt && cargo clippy && cargo run ) ( cd ./test/lint/test_runner/ && cargo fmt && cargo clippy && cargo run )
``` ```
#### Dependencies
| Lint test | Dependency |
|-----------|:----------:|
| [`lint-python.py`](lint/lint-python.py) | [flake8](https://gitlab.com/pycqa/flake8)
| [`lint-python.py`](lint/lint-python.py) | [lief](https://github.com/lief-project/LIEF)
| [`lint-python.py`](lint/lint-python.py) | [mypy](https://github.com/python/mypy)
| [`lint-python.py`](lint/lint-python.py) | [pyzmq](https://github.com/zeromq/pyzmq)
| [`lint-python-dead-code.py`](lint/lint-python-dead-code.py) | [vulture](https://github.com/jendrikseipp/vulture)
| [`lint-shell.py`](lint/lint-shell.py) | [ShellCheck](https://github.com/koalaman/shellcheck)
| [`lint-spelling.py`](lint/lint-spelling.py) | [codespell](https://github.com/codespell-project/codespell)
In use versions and install instructions are available in the [CI setup](../ci/lint/04_install.sh).
Please be aware that on Linux distributions all dependencies are usually available as packages, but could be outdated.
#### Running the tests
Individual tests can be run by directly calling the test script, e.g.:
```
test/lint/lint-files.py
```
You can run all the shell-based lint tests by running:
```
test/lint/all-lint.py
```
check-doc.py check-doc.py
============ ============
Check for missing documentation of command line options. Check for missing documentation of command line options.