doc: mempool: fix `removeUnchecked` incorrect comment
What the developer wrote
Authored by ismaelsadeeq
doc: mempool: fix `removeUnchecked` incorrect comment
- CTxMemPool::removeUnchecked description comment is stale and incorrect
after cluster mempool.
This commit fixes the issue by deleting the stale comment and describing
only the implicit behaviour triggered by the method.
What changed, and why it matters
This commit only changes a code comment in a header file. It deletes an outdated, incorrect description of the removeUnchecked function and replaces it with a short, accurate note. No program logic, behavior, or security boundary is changed.
No action required; treat as a normal documentation-only cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff in src/txmempool.h removes a stale Doxygen-style comment block for CTxMemPool::removeUnchecked that described pre-cluster-mempool requirements (calling UpdateForRemoveFromMempool on the full dependent set before removal) and substitutes a one-line comment noting the implicit txgraph Ref removal side effect. There are no code, control-flow, or API changes.
Changed components
src/txmempool.h documentation comment for CTxMemPool::removeUncheckedInspect captured patch +1 / −8
diff --git a/src/txmempool.h b/src/txmempool.h
index bef711d4..996a1fe0 100644
--- a/src/txmempool.h
+++ b/src/txmempool.h
@@ -589,14 +589,7 @@ private:
/* Helper for the public removeRecursive() */
void removeRecursive(txiter to_remove, MemPoolRemovalReason reason) EXCLUSIVE_LOCKS_REQUIRED(cs);
- /** Before calling removeUnchecked for a given transaction,
- * UpdateForRemoveFromMempool must be called on the entire (dependent) set
- * of transactions being removed at the same time. We use each
- * CTxMemPoolEntry's m_parents in order to walk ancestors of a
- * given transaction that is removed, so we can't remove intermediate
- * transactions in a chain before we've updated all the state for the
- * removal.
- */
+ /* Removal from the mempool also triggers removal of the entry's Ref from txgraph. */
void removeUnchecked(txiter entry, MemPoolRemovalReason reason) EXCLUSIVE_LOCKS_REQUIRED(cs);
public:
/** visited marks a CTxMemPoolEntry as having been traversed
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.