History

Jon Atack 6c008a2006 script: replace deprecated pkg_resources with importlib.metadata in our python linter: ``` ./test/lint/lint-python.py:12: DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html import pkg_resources ``` The importlib.metadata library was added in Python 3.8, which is currently our minimum-supported Python version. For more details about importlib.metadata, see https://docs.python.org/3/library/importlib.metadata.html		1 year ago
..
README.md	ci: Use DOCKER_BUILDKIT for lint image	1 year ago
all-lint.py	…
check-doc.py	…
commit-script-check.sh	…
git-subtree-check.sh	…
lint-assertions.py	test: Make linter to look for `BOOST_ASSERT` macros	1 year ago
lint-circular-dependencies.py	Remove unused includes from wallet.cpp	1 year ago
lint-files.py	…
lint-format-strings.py	tidy: Integrate bicoin-tidy clang-tidy plugin	1 year ago
lint-git-commit-check.py	…
lint-include-guards.py	tidy: Integrate bicoin-tidy clang-tidy plugin	1 year ago
lint-includes.py	tidy: Integrate bicoin-tidy clang-tidy plugin	1 year ago
lint-locale-dependence.py	fuzz: Remove legacy int parse fuzz tests	2 years ago
lint-python-dead-code.py	…
lint-python-mutable-default-parameters.py	…
lint-python-utf8-encoding.py	lint: Ignore check_fileopens failure on **kwargs	1 year ago
lint-python.py	script: replace deprecated pkg_resources with importlib.metadata	1 year ago
lint-shell-locale.py	…
lint-shell.py	…
lint-spelling.py	…
lint-submodule.py	…
lint-tests.py	…
lint-whitespace.py	…
run-lint-format-strings.py	refactor: Enforce C-str fmt strings in WalletLogPrintf()	1 year ago
spelling.ignore-words.txt	script: update ignored-words.txt	1 year 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:

DOCKER_BUILDKIT=1 docker build -t bitcoin-linter --file "./ci/lint_imagefile" ./

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:

for src/secp256k1: https://github.com/bitcoin-core/secp256k1.git (branch master)
for src/leveldb: https://github.com/bitcoin-core/leveldb-subtree.git (branch bitcoin-fork)
for src/crypto/ctaes: https://github.com/bitcoin-core/ctaes.git (branch master)
for src/crc32c: https://github.com/bitcoin-core/crc32c-subtree.git (branch bitcoin-fork)
for src/minisketch: https://github.com/sipa/minisketch.git (branch master)

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.