versionbits: update VersionBitsCache doc comment to match current behaviour
What the developer wrote
Authored by Antoine Poinsot
versionbits: update VersionBitsCache doc comment to match current behaviour
Co-Authored-by: Anthony Towns <aj@erisian.com.au>
What changed, and why it matters
This commit only updates a code comment in a header file to describe the current behavior of a cache used for tracking Bitcoin softfork deployment status. No executable code was changed, and there is no security impact.
No action required; this is a non-functional documentation update.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies a single Doxygen-style documentation comment for the VersionBitsCache class in src/versionbits.h. It clarifies that the cache stores per-period state for implemented softforks and warning state for each allowed BIP 323 bit. No logic, interfaces, or data structures were altered.
Changed components
src/versionbits.h (documentation only)Inspect captured patch +2 / −1
diff --git a/src/versionbits.h b/src/versionbits.h
index 0ac17287..f88ead0d 100644
--- a/src/versionbits.h
+++ b/src/versionbits.h
@@ -72,7 +72,8 @@ struct BIP9GBTStatus {
};
/** BIP 9 allows multiple softforks to be deployed in parallel. We cache
- * per-period state for every one of them. */
+ * per-period state for every one we implement and warning state for each
+ * BIP 323 allowed bit. */
class VersionBitsCache
{
private:
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.