Skip to content

Commit f89000a

Browse files
comment tweaks
1 parent 8db4cad commit f89000a

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

storage/src/journal/contiguous/fixed.rs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,13 @@
4040
//!
4141
//! # Metadata
4242
//!
43-
//! Metadata consists of two optional keys:
43+
//! Metadata contains the following keys:
4444
//! - PRUNING_BOUNDARY_KEY: Stores the pruning boundary as a u64 when it's mid-section (not a
4545
//! multiple of items_per_blob). Absent from legacy journals or when the boundary is
4646
//! section-aligned, since it can be derived from the oldest blob.
4747
//! - RECOVERY_WATERMARK_KEY: Stores the last logical size at which the fixed journal's entries and
48-
//! metadata were synced as a coherent recovery checkpoint for external consumers. Fixed-journal
49-
//! recovery does not use this value to decide whether short blobs are corrupt. Absent on journals
50-
//! created before this key was added; those journals recover from the newest retained blob using
51-
//! the old rollover-sync invariant, then write the key before accepting new appends.
48+
//! metadata were synced as a coherent recovery checkpoint for external consumers. Journals created
49+
//! before this key was introduced may lack it; initialization writes the key before returning.
5250
//!
5351
//! RECOVERY_WATERMARK_KEY is mainly useful when this journal is used as an index for a layered
5452
//! journal, such as the variable journal's offsets. Standalone fixed journals do not need it to

0 commit comments

Comments
 (0)