From f26a457cf5212f88a369b00e45466707ffd5d898 Mon Sep 17 00:00:00 2001
From: Yueh-Hsuan Chiang <93241502+yhchiang-sol@users.noreply.github.com>
Date: Thu, 20 Oct 2022 09:47:19 -0700
Subject: [PATCH] Add comment block for DeadSlots LedgerColumn (#28341)

Add comment block for DeadSlots LedgerColumn
---
 ledger/src/blockstore_db.rs | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/ledger/src/blockstore_db.rs b/ledger/src/blockstore_db.rs
index 426781a42e..7801babc93 100644
--- a/ledger/src/blockstore_db.rs
+++ b/ledger/src/blockstore_db.rs
@@ -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