mirror of https://github.com/bitcoin/bitcoin.git synced 2026-04-11 16:17:54 +02:00

Files

merge-script 2b541eeb36 Merge bitcoin/bitcoin#34495 : Replace boost signals with minimal compatible implementation

242b0ebb5c btcsignals: use a single shared_ptr for liveness and callback (Cory Fields)
b12f43a0a8 signals: remove boost::signals2 from depends and vcpkg (Cory Fields)
a4b1607983 signals: remove boost::signals2 mentions in linters and docs (Cory Fields)
375397ebd9 signals: remove boost includes where possible (Cory Fields)
091736a153 signals: re-add forward-declares to interface headers (Cory Fields)
9958f4fe49 Revert "signals: Temporarily add boost headers to bitcoind and bitcoin-node builds" (Cory Fields)
34eabd77a2 signals: remove boost compatibility guards (Cory Fields)
e60a0b9a22 signals: Add a simplified boost-compatible implementation (Cory Fields)
63c68e2a3f signals: add signals tests (Cory Fields)
edc2978058 signals: use an alias for the boost::signals2 namespace (Cory Fields)
9ade3929aa signals: remove forward-declare for signals (Cory Fields)
037e58b57b signals: use forwarding header for boost signals (Cory Fields)
2150153f37 signals: Temporarily add boost headers to bitcoind and bitcoin-node builds (Cory Fields)
fd5e9d9904 signals: Use a lambda to avoid connecting a signal to another signal (Cory Fields)

Pull request description:

  This drops our dependency on `boost::signals2`, leaving `boost::multi_index` as the only remaining boost dependency for bitcoind.

  `boost::signals2` is a complex beast, but we only use a small portion of it. Namely: it's a way for multiple subscribers to connect to the same event, and the ability to later disconnect individual subscribers from that event.

  `btcsignals` adheres to the subset of the `boost::signals2` API that we currently use, and thus is a drop-in replacement. Rather than implementing a complex `slot` tracking class that we never used anyway (and which was much more useful in the days before std::function existed), callbacks are simply wrapped directly in `std::function`s.

  The new tests work with either `boost::signals2` or the new `btcsignals` implementation. Reviewers can verify
  functional equivalency by running the tests in the commit that introduces them against `boost::signals2`, then again with `btcsignals`.

  The majority of the commits in this PR are preparation and cleanup. Once `boost::signals2` is no longer needed, it is removed from depends. Additionally, a few CMake targets no longer need boost includes as they were previously only required for signals.

  I think this is actually pretty straightforward to review. I kept things simple, including keeping types unmovable/uncopyable where possible rather than trying to define those semantics. In doing so, the new implementation has even fewer type requirements than boost, which I believe is due to a boost bug. I've opened a PR upstream for that to attempt to maintain parity between the implementations.

  See individual commits for more details.

  Closes #26442.

ACKs for top commit:
  fjahr:
    Code review ACK 242b0ebb5c
  maflcko:
    re-review ACK 242b0ebb5c 🎯
  w0xlt:
    reACK 242b0ebb5c

Tree-SHA512: 9a472afa4f655624fa44493774a63b57509ad30fb61bf1d89b6d0b52000cb9a1409a5b8d515a99c76e0b26b2437c30508206c29a7dd44ea96eb1979d572cd4d4

2026-04-09 16:25:47 +08:00

test_runner

lint: Clarify rmtree/remove_all error message with preferred alternatives

2026-04-01 10:21:52 +02:00

check-doc.py

contrib: Use text=True in subprocess over manual encoding handling

2025-11-26 11:31:29 +01:00

commit-script-check.sh

scripted-diff: [doc] Unify stale copyright headers

2025-12-16 22:21:15 +01:00

git-subtree-check.sh

lint: fix lint issue in lint script

2026-03-16 23:24:52 +08:00

lint_ignore_dirs.py

lint: more reuse of SHARED_EXCLUDED_SUBTREES

2026-03-16 23:24:52 +08:00

lint-circular-dependencies.py

scripted-diff: [doc] Unify stale copyright headers

2025-12-16 22:21:15 +01:00

lint-files.py

contrib: Use text=True in subprocess over manual encoding handling

2025-11-26 11:31:29 +01:00

lint-include-guards.py

lint: more reuse of SHARED_EXCLUDED_SUBTREES

2026-03-16 23:24:52 +08:00

lint-includes.py

Merge bitcoin/bitcoin#34495 : Replace boost signals with minimal compatible implementation

2026-04-09 16:25:47 +08:00

lint-locale-dependence.py

lint: more reuse of SHARED_EXCLUDED_SUBTREES

2026-03-16 23:24:52 +08:00

lint-python.py

contrib: Use text=True in subprocess over manual encoding handling

2025-11-26 11:31:29 +01:00

lint-qt-translation.py

lint: Add lint-qt-translation.py

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

lint-shell-locale.py

contrib: Use text=True in subprocess over manual encoding handling

2025-11-26 11:31:29 +01:00

lint-shell.py

scripted-diff: [doc] Unify stale copyright headers

2025-12-16 22:21:15 +01:00

lint-submodule.py

contrib: Use text=True in subprocess over manual encoding handling

2025-11-26 11:31:29 +01:00

lint-tests.py

lint: add missing ipc/test to grep_boost_fixture_test_suite

2026-03-16 23:24:52 +08:00

README.md

ci: Remove vulture

2026-03-12 13:19:00 +01:00

README.md

This folder contains lint scripts.

Running locally

To run linters locally with the same versions as the CI environment use the lint.py helper script which runs checks inside the CI container:

./ci/lint.py

Extra arguments are passed to cargo run -- ... in the container so you can do:

./ci/lint.py --help
./ci/lint.py --lint=py_lint

test runner

To run all the lint checks in the test runner outside the container 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 )

If you wish to run individual lint checks, run the test_runner with --lint=TEST_TO_RUN arguments. If running with cargo run, arguments after -- are passed to the binary you are running e.g.:

( cd ./test/lint/test_runner/ && RUST_BACKTRACE=1 cargo run -- --lint=doc --lint=trailing_whitespace )

To see a list of all individual lint checks available in test_runner, use -h or --help:

( cd ./test/lint/test_runner/ && RUST_BACKTRACE=1 cargo run -- --help )

Dependencies

Lint test	Dependency
`lint-python.py`	lief
`lint-python.py`	mypy
`lint-python.py`	pyzmq
`lint-shell.py`	ShellCheck
`py_lint`	ruff
markdown link check	mlc

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/crc32c: https://github.com/bitcoin-core/crc32c-subtree.git (branch bitcoin-fork)
for src/crypto/ctaes: https://github.com/bitcoin-core/ctaes.git (branch master)
for src/ipc/libmultiprocess: https://github.com/bitcoin-core/libmultiprocess (branch master)
for src/leveldb: https://github.com/bitcoin-core/leveldb-subtree.git (branch bitcoin-fork)
for src/minisketch: https://github.com/bitcoin-core/minisketch.git (branch master)
for src/secp256k1: https://github.com/bitcoin-core/secp256k1.git (branch master)

Keep this list in sync with fn get_subtrees() in the lint runner.

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