Add comment block for DeadSlots LedgerColumn (#28341)

Add comment block for DeadSlots LedgerColumn
This commit is contained in:
Yueh-Hsuan Chiang 2022-10-20 09:47:19 -07:00 committed by GitHub
parent a1b03ec1b4
commit f26a457cf5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions

View File

@ -157,7 +157,16 @@ pub mod columns {
pub struct Orphans;
#[derive(Debug)]
/// The dead slots column
/// The dead slots column.
/// This column family tracks whether a slot is dead.
///
/// A slot is marked as dead if the validator thinks it will never be able
/// to successfully replay this slot. Example scenarios include errors
/// during the replay of a slot, or the validator believes it will never
/// receive all the shreds of a slot.
///
/// If a slot has been mistakenly marked as dead, the ledger-tool's
/// --remove-dead-slot can unmark a dead slot.
///
/// index type: u64 (see `SlotColumn`)
/// value type: bool