diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2018-05-19 10:27:54 -0400 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2018-05-24 12:02:15 -0400 |
| commit | fa3c910bfeab00703c947c5200a64c21225b50ef (patch) | |
| tree | 6d8e8ad2d248c22fece1f5c1bebd6cf9ace38db0 /test/lint/README.md | |
| parent | d9ebb63919fb311ace0ae977e3183ccb80ed7d3c (diff) | |
| download | bitcoin-fa3c910bfeab00703c947c5200a64c21225b50ef.tar.xz | |
test: Move linters to test/lint, add readme
Diffstat (limited to 'test/lint/README.md')
| -rw-r--r-- | test/lint/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/test/lint/README.md b/test/lint/README.md new file mode 100644 index 0000000000..15974a3598 --- /dev/null +++ b/test/lint/README.md @@ -0,0 +1,29 @@ +This folder contains lint scripts. + +check-doc.py +============ +Check for missing documentation of command line options. + +commit-script-check.sh +====================== +Verification of [scripted diffs](/doc/developer-notes.md#scripted-diffs). + +git-subtree-check.sh +==================== +Run this script from the root of the repository to verify that a subtree matches the contents of +the commit it claims to have been updated to. + +To use, make sure that you have fetched the upstream repository branch in which the subtree is +maintained: +* for `src/secp256k1`: https://github.com/bitcoin-core/secp256k1.git (branch master) +* for `src/leveldb`: https://github.com/bitcoin-core/leveldb.git (branch bitcoin-fork) +* for `src/univalue`: https://github.com/bitcoin-core/univalue.git (branch master) +* for `src/crypto/ctaes`: https://github.com/bitcoin-core/ctaes.git (branch master) + +Usage: `git-subtree-check.sh DIR (COMMIT)` + +`COMMIT` may be omitted, in which case `HEAD` is used. + +lint-all.sh +=========== +Calls other scripts with the `lint-` prefix. |