signals: remove boost::signals2 mentions in linters and docs
What the developer wrote
Authored by Cory Fields
signals: remove boost::signals2 mentions in linters and docs
The documented example is no longer relevant, so remove it rather than updating
it to mention btcsignals.
What changed, and why it matters
This commit is a routine cleanup of documentation and a linting script. It updates an example in the developer notes to reference the project's own signal library (btcsignals) instead of the old Boost signals2 library, and removes three Boost signals2 header paths from the list of expected Boost includes checked by a linter. There is no code behavior change and no security relevance.
No security action needed. This is a documentation and lint-list maintenance commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff touches only doc/developer-notes.md and test/lint/lint-includes.py. It replaces ‘boost::signals2’ with ‘btcsignals’ in a documentation example illustrating good/bad interface design, and removes boost/signals2/connection.hpp, boost/signals2/optional_last_value.hpp, and boost/signals2/signal.hpp from EXPECTED_BOOST_INCLUDES. No functional code is modified.
Changed components
doc/developer-notes.mdtest/lint/lint-includes.pyInspect captured patch +2 / −5
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index 97ffc0cd..c30fb509 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -1411,9 +1411,9 @@ communication:
using TipChangedFn = std::function<void(int block_height, int64_t block_time)>;
virtual std::unique_ptr<interfaces::Handler> handleTipChanged(TipChangedFn fn) = 0;
- // Bad: returns boost connection specific to local process
+ // Bad: returns btcsignals connection specific to local process
using TipChangedFn = std::function<void(int block_height, int64_t block_time)>;
- virtual boost::signals2::scoped_connection connectTipChanged(TipChangedFn fn) = 0;
+ virtual btcsignals::scoped_connection connectTipChanged(TipChangedFn fn) = 0;
```
- Interface methods should not be overloaded.
diff --git a/test/lint/lint-includes.py b/test/lint/lint-includes.py
index cccaec73..2e8417ea 100755
--- a/test/lint/lint-includes.py
+++ b/test/lint/lint-includes.py
@@ -30,9 +30,6 @@ EXPECTED_BOOST_INCLUDES = [
"boost/multi_index/tag.hpp",
"boost/multi_index_container.hpp",
"boost/operators.hpp",
- "boost/signals2/connection.hpp",
- "boost/signals2/optional_last_value.hpp",
- "boost/signals2/signal.hpp",
"boost/test/included/unit_test.hpp",
"boost/test/unit_test.hpp",
"boost/tuple/tuple.hpp",
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.