Skip to content

Commit fadb06c

Browse files
author
MarcoFalke
committed
doc: move-only lint docs to one place
Can be reviewed with --color-moved=dimmed-zebra
1 parent 2ac2821 commit fadb06c

File tree

2 files changed

+31
-29
lines changed

2 files changed

+31
-29
lines changed

test/README.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -326,35 +326,7 @@ Use the `-v` option for verbose output.
326326

327327
### Lint tests
328328

329-
#### Dependencies
330-
331-
| Lint test | Dependency |
332-
|-----------|:----------:|
333-
| [`lint-python.py`](lint/lint-python.py) | [flake8](https://gitlab.com/pycqa/flake8)
334-
| [`lint-python.py`](lint/lint-python.py) | [lief](https://github.com/lief-project/LIEF)
335-
| [`lint-python.py`](lint/lint-python.py) | [mypy](https://github.com/python/mypy)
336-
| [`lint-python.py`](lint/lint-python.py) | [pyzmq](https://github.com/zeromq/pyzmq)
337-
| [`lint-python-dead-code.py`](lint/lint-python-dead-code.py) | [vulture](https://github.com/jendrikseipp/vulture)
338-
| [`lint-shell.py`](lint/lint-shell.py) | [ShellCheck](https://github.com/koalaman/shellcheck)
339-
| [`lint-spelling.py`](lint/lint-spelling.py) | [codespell](https://github.com/codespell-project/codespell)
340-
341-
In use versions and install instructions are available in the [CI setup](../ci/lint/04_install.sh).
342-
343-
Please be aware that on Linux distributions all dependencies are usually available as packages, but could be outdated.
344-
345-
#### Running the tests
346-
347-
Individual tests can be run by directly calling the test script, e.g.:
348-
349-
```
350-
test/lint/lint-files.py
351-
```
352-
353-
You can run all the shell-based lint tests by running:
354-
355-
```
356-
test/lint/all-lint.py
357-
```
329+
See the README in [test/lint](/test/lint).
358330

359331
# Writing functional tests
360332

test/lint/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,36 @@ To run the checks in the test runner outside the docker, use:
2222
( cd ./test/lint/test_runner/ && cargo fmt && cargo clippy && cargo run )
2323
```
2424

25+
#### Dependencies
26+
27+
| Lint test | Dependency |
28+
|-----------|:----------:|
29+
| [`lint-python.py`](lint/lint-python.py) | [flake8](https://gitlab.com/pycqa/flake8)
30+
| [`lint-python.py`](lint/lint-python.py) | [lief](https://github.com/lief-project/LIEF)
31+
| [`lint-python.py`](lint/lint-python.py) | [mypy](https://github.com/python/mypy)
32+
| [`lint-python.py`](lint/lint-python.py) | [pyzmq](https://github.com/zeromq/pyzmq)
33+
| [`lint-python-dead-code.py`](lint/lint-python-dead-code.py) | [vulture](https://github.com/jendrikseipp/vulture)
34+
| [`lint-shell.py`](lint/lint-shell.py) | [ShellCheck](https://github.com/koalaman/shellcheck)
35+
| [`lint-spelling.py`](lint/lint-spelling.py) | [codespell](https://github.com/codespell-project/codespell)
36+
37+
In use versions and install instructions are available in the [CI setup](../ci/lint/04_install.sh).
38+
39+
Please be aware that on Linux distributions all dependencies are usually available as packages, but could be outdated.
40+
41+
#### Running the tests
42+
43+
Individual tests can be run by directly calling the test script, e.g.:
44+
45+
```
46+
test/lint/lint-files.py
47+
```
48+
49+
You can run all the shell-based lint tests by running:
50+
51+
```
52+
test/lint/all-lint.py
53+
```
54+
2555
check-doc.py
2656
============
2757
Check for missing documentation of command line options.

0 commit comments

Comments
 (0)