Skip to content

Commit 8e1c13e

Browse files
committed
doc: Document -checklevel levels
Document the various possible check levels for the command-line argument. The numbers say nothing on their own.
1 parent 1c12cf6 commit 8e1c13e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/init.cpp

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,14 @@ void SetupServerArgs()
426426
#endif
427427

428428
gArgs.AddArg("-checkblocks=<n>", strprintf("How many blocks to check at startup (default: %u, 0 = all)", DEFAULT_CHECKBLOCKS), true, OptionsCategory::DEBUG_TEST);
429-
gArgs.AddArg("-checklevel=<n>", strprintf("How thorough the block verification of -checkblocks is (0-4, default: %u)", DEFAULT_CHECKLEVEL), true, OptionsCategory::DEBUG_TEST);
429+
gArgs.AddArg("-checklevel=<n>", strprintf("How thorough the block verification of -checkblocks is: "
430+
"level 0 reads the blocks from disk, "
431+
"level 1 verifies block validity, "
432+
"level 2 verifies undo data, "
433+
"level 3 checks disconnection of tip blocks, "
434+
"and level 4 tries to reconnect the blocks, "
435+
"each level includes the checks of the previous levels "
436+
"(0-4, default: %u)", DEFAULT_CHECKLEVEL), true, OptionsCategory::DEBUG_TEST);
430437
gArgs.AddArg("-checkblockindex", strprintf("Do a full consistency check for mapBlockIndex, setBlockIndexCandidates, chainActive and mapBlocksUnlinked occasionally. (default: %u, regtest: %u)", defaultChainParams->DefaultConsistencyChecks(), regtestChainParams->DefaultConsistencyChecks()), true, OptionsCategory::DEBUG_TEST);
431438
gArgs.AddArg("-checkmempool=<n>", strprintf("Run checks every <n> transactions (default: %u, regtest: %u)", defaultChainParams->DefaultConsistencyChecks(), regtestChainParams->DefaultConsistencyChecks()), true, OptionsCategory::DEBUG_TEST);
432439
gArgs.AddArg("-checkpoints", strprintf("Disable expensive verification for known chain history (default: %u)", DEFAULT_CHECKPOINTS_ENABLED), true, OptionsCategory::DEBUG_TEST);

0 commit comments

Comments
 (0)