mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-27 10:12:16 +01:00

History

Merge bitcoin/bitcoin#29494 : build: Assume HAVE_CONFIG_H, Add IWYU pragma keep to bitcoin-config.h includes

fa09451f8e6799682d7e7c863f25334fd1c7dce3 Add lint check for bitcoin-config.h include IWYU pragma (MarcoFalke)
dddd40ba8267dea11a3eb03d5cf8b51dbb99be5d scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes (MarcoFalke)

Pull request description:

  The `bitcoin-config.h` includes have issues:

  * The header is incompatible with iwyu, because symbols may be defined or not defined. So the `IWYU pragma: keep` is needed to keep the include when a symbol is not defined on a platform. Compare the previous discussion in https://github.com/bitcoin/bitcoin/pull/29408#issuecomment-1948959711
  * Guarding the includes by `HAVE_CONFIG_H` is verbose and brittle. Now that all build config dependencies have been removed from low level headers, the benefits are questionable, and the guard can be removed. The linter could also be tricked by guarding the include by `#if defined(HAVE_C0NFIG_H)` (`O` replaced by `0`). Compare the previous discussion in https://github.com/bitcoin/bitcoin/pull/29404#discussion_r1483189853 .

ACKs for top commit:
  achow101:
    ACK fa09451f8e6799682d7e7c863f25334fd1c7dce3
  TheCharlatan:
    ACK fa09451f8e6799682d7e7c863f25334fd1c7dce3
  hebasto:
    re-ACK fa09451f8e6799682d7e7c863f25334fd1c7dce3, only rebased since my recent [review](https://github.com/bitcoin/bitcoin/pull/29494#pullrequestreview-2028864535) (`timedata.cpp` removed in https://github.com/bitcoin/bitcoin/pull/29623).

Tree-SHA512: 47cb973f7f24bc625acc4e78683371863675d186780236d55d886cf4130e05a78bb04f1d731aae7088313b8e963a9677cc77cf518187dbd99d776f6421ca9b52

2024-05-07 14:14:03 -04:00

test_runner

Merge bitcoin/bitcoin#29494 : build: Assume HAVE_CONFIG_H, Add IWYU pragma keep to bitcoin-config.h includes

2024-05-07 14:14:03 -04:00

check-doc.py

init: completely remove -zapwallettxes (remaining hidden option)

2023-11-03 20:00:44 +01:00

commit-script-check.sh

lint: scripted-diff verification also requires GNU grep

2024-03-21 13:12:19 +01:00

git-subtree-check.sh

scripted-diff: Bump copyright headers

2021-12-30 19:36:57 +02:00

lint_ignore_dirs.py

test: Refactor subtree exclusion in lint tests

2024-03-26 13:49:47 +03:00

lint-assertions.py

doc: Remove confusing assert linter

2023-09-14 18:59:52 +02:00

lint-circular-dependencies.py

refactor: Remove unused circular include dependency from validation.cpp

2023-11-01 17:45:48 +01:00

lint-files.py

test: use built-in collection types for type hints (Python 3.9 / PEP 585)

2023-10-25 01:10:21 +02:00

lint-format-strings.py

logging: add LogError, LogWarning, LogInfo, LogDebug, LogTrace

2023-12-20 15:59:48 +10:00

lint-git-commit-check.py

lint: Fix COMMIT_RANGE issues

2024-03-21 20:15:08 +01:00

lint-include-guards.py

test: Refactor subtree exclusion in lint tests

2024-03-26 13:49:47 +03:00

lint-includes.py

external_signer: replace boost::process with cpp-subprocess

2024-03-27 14:16:37 +00:00

lint-locale-dependence.py

fuzz: Remove legacy int parse fuzz tests

2023-03-27 16:37:31 +02:00

lint-python-dead-code.py

lint: Convert Python dead code linter to Python

2022-04-06 00:55:22 +02:00

lint-python-mutable-default-parameters.py

scripted-diff: Use new python 3.7 keywords

2023-01-18 13:00:34 +01:00

lint-python-utf8-encoding.py

lint: Ignore check_fileopens failure on **kwargs

2023-07-20 09:15:43 +02:00

lint-python.py

lint: fix custom mypy cache dir setting

2023-09-28 13:20:25 +02:00

lint-qt-translation.py

lint: Add lint-qt-translation.py

2023-10-23 15:07:02 +01:00

lint-shell-locale.py

refactor: cleanups post unsubtree'ing univalue

2022-06-15 12:56:44 +01:00

lint-shell.py

lint: Include test_utxo_snapshots in lint_shell

2023-10-13 14:06:06 +02:00

lint-spelling.py

Fix typos in subprocess.hpp

2024-04-11 14:03:37 +02:00

lint-submodule.py

scripted-diff: Use new python 3.7 keywords

2023-01-18 13:00:34 +01:00

lint-tests.py

scripted-diff: Use new python 3.7 keywords

2023-01-18 13:00:34 +01:00

README.md

test: Refactor subtree exclusion in lint tests

2024-03-26 13:49:47 +03:00

run-lint-format-strings.py

refactor: Enforce C-str fmt strings in WalletLogPrintf()

2023-08-08 10:55:11 +02:00

spelling.ignore-words.txt

doc: fix typos

2023-11-07 10:21:51 +09:00

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

Building the container can be done every time, because it is fast when the result is cached and it prevents issues when the image changes.

test runner

To run all the lint checks in the test runner outside the docker you first need to install the rust toolchain using your package manager of choice or rustup.

Then you can use:

( cd ./test/lint/test_runner/ && cargo fmt && cargo clippy && RUST_BACKTRACE=1 cargo run )

Dependencies

Lint test	Dependency
`lint-python.py`	flake8
`lint-python.py`	lief
`lint-python.py`	mypy
`lint-python.py`	pyzmq
`lint-python-dead-code.py`	vulture
`lint-shell.py`	ShellCheck
`lint-spelling.py`	codespell

In use versions and install instructions are available in the CI setup.

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

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

lint_ignore_dirs.py

Add list of common directories to ignore when running tests