mining: clarify test_block_validity comment
What the developer wrote
Authored by Sjors Provoost
mining: clarify test_block_validity comment
The option defaults to true, so describe the intended exceptional use
case as disabling validation for tests and benchmarks.
Suggested in https://github.com/bitcoin/bitcoin/pull/33966#discussion_r3303387586
What changed, and why it matters
This commit only rewords a code comment in a header file. It changes 'Should only be used for tests / benchmarks' to 'Should only be disabled for tests / benchmarks' to make the documentation clearer. No code behavior changed, and there is no security issue.
No action needed; this is a non-functional documentation change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
A single-line comment change in src/node/mining_types.h for the test_block_validity field of BlockCreateOptions. The default value remains true and no executable code was modified. The change is purely editorial clarification.
Changed components
src/node/mining_types.hInspect captured patch +1 / −1
diff --git a/src/node/mining_types.h b/src/node/mining_types.h
index 9c4fbcbb..6e4eb82a 100644
--- a/src/node/mining_types.h
+++ b/src/node/mining_types.h
@@ -86,7 +86,7 @@ struct BlockCreateOptions {
CScript coinbase_output_script{CScript() << OP_TRUE};
/**
* Whether to call TestBlockValidity() at the end of CreateNewBlock().
- * Should only be used for tests / benchmarks.
+ * Should only be disabled for tests / benchmarks.
*/
bool test_block_validity{true};
};
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.