boxtec
/
bitcoin
mirror of https://github.com/bitcoin/bitcoin
4
1
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ff17b28b02'
${ noResults }
bitcoin/test/lint
History
Hennadii Stepanov 2484cacb7a
Add public Boost headers explicitly 		1 year ago
..
README.md test: add an easy way to run linters locally 2 years ago
all-lint.py Use same Python executable for subprocesses as for all-lint.py 2 years ago
check-doc.py scripted-diff: Bump copyright headers 2 years ago
commit-script-check.sh scripted-diff: Bump copyright headers 2 years ago
git-subtree-check.sh scripted-diff: Bump copyright headers 3 years ago
lint-assertions.py scripted-diff: Use new python 3.7 keywords 2 years ago
lint-circular-dependencies.py move-only: Extract common/args and common/config.cpp from util/system 2 years ago
lint-files.py scripted-diff: Bump copyright headers 2 years ago
lint-format-strings.py refactor: cleanups post unsubtree'ing univalue 2 years ago
lint-git-commit-check.py scripted-diff: Use new python 3.7 keywords 2 years ago
lint-include-guards.py refactor: cleanups post unsubtree'ing univalue 2 years ago
lint-includes.py Add public Boost headers explicitly 1 year ago
lint-locale-dependence.py fuzz: Remove legacy int parse fuzz tests 2 years ago
lint-logs.py scripted-diff: Use new python 3.7 keywords 2 years ago
lint-python-dead-code.py lint: Convert Python dead code linter to Python 3 years ago
lint-python-mutable-default-parameters.py scripted-diff: Use new python 3.7 keywords 2 years ago
lint-python-utf8-encoding.py Disable Python lint in src/secp256k1 2 years ago
lint-python.py lint: stop ignoring LIEF imports 1 year ago
lint-shell-locale.py refactor: cleanups post unsubtree'ing univalue 2 years ago
lint-shell.py scripted-diff: Use new python 3.7 keywords 2 years ago
lint-spelling.py contrib: remove builder keys 2 years ago
lint-submodule.py scripted-diff: Use new python 3.7 keywords 2 years ago
lint-tests.py scripted-diff: Use new python 3.7 keywords 2 years ago
lint-whitespace.py scripted-diff: Use new python 3.7 keywords 2 years ago
run-lint-format-strings.py lint: Fix lint-format-strings false positives when format specifiers have argument positions 2 years ago
spelling.ignore-words.txt add `lief` to `spelling.ignore-words` 2 years ago

README.md

This folder contains lint scripts.

Running locally

To run linters locally with the same versions as the CI environment, use the included Dockerfile:

cd ./ci/lint
docker build -t bitcoin-linter .

cd /root/of/bitcoin/repo
docker run --rm -v $(pwd):/bitcoin -it bitcoin-linter

After building the container once, you can simply run the last command any time you want to lint.

check-doc.py

Check for missing documentation of command line options.

commit-script-check.sh

Verification of scripted diffs. Scripted diffs are only assumed to run on the latest LTS release of Ubuntu. Running them on other operating systems might require installing GNU tools, such as GNU sed.

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.

Usage: test/lint/git-subtree-check.sh [-r] DIR [COMMIT]
       test/lint/git-subtree-check.sh -?
  • DIR is the prefix within the repository to check.
  • COMMIT is the commit to check, if it is not provided, HEAD will be used.
  • -r checks that subtree commit is present in repository.

To do a full check with -r, make sure that you have fetched the upstream repository branch in which the subtree is maintained:

To do so, add the upstream repository as remote:

git remote add --fetch secp256k1 https://github.com/bitcoin-core/secp256k1.git

all-lint.py

Calls other scripts with the lint- prefix.