Skip to content

Commit 2f277c6

Browse files
committed
LedgerDB.garbageCollect: update documentation
regarding the previous few commits
1 parent 3e44253 commit 2f277c6

File tree

1 file changed

+8
-2
lines changed
  • ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB

1 file changed

+8
-2
lines changed

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/API.hs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,8 +252,14 @@ data LedgerDB m l blk = LedgerDB
252252
, getPrevApplied :: STM m (Set (RealPoint blk))
253253
-- ^ Get the references to blocks that have previously been applied.
254254
, garbageCollect :: SlotNo -> m ()
255-
-- ^ Garbage collect references to old blocks that have been previously
256-
-- applied and committed.
255+
-- ^ Garbage collect references to old state that is older than the given
256+
-- slot.
257+
--
258+
-- Concretely, this affects:
259+
--
260+
-- * Ledger states (and potentially underlying handles for on-disk storage).
261+
--
262+
-- * The set of previously applied points.
257263
, tryTakeSnapshot ::
258264
l ~ ExtLedgerState blk =>
259265
Maybe (Time, Time) ->

0 commit comments

Comments
 (0)