fix docs

Signed-off-by: Alex Chi Z <[email protected]>
neondatabase · Dec 9, 2024 · 98923e5 · 98923e5
1 parent 47cac21
commit 98923e5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/pageserver/src/tenant/timeline.rs b/pageserver/src/tenant/timeline.rs
@@ -851,10 +851,10 @@ impl CompactLsnRange {
 pub(crate) struct CompactOptions {
     pub flags: EnumSet<CompactFlags>,
     /// If set, the compaction will only compact the key range specified by this option.
-    /// This option is only used by GC compaction. For the full explanation, see [`GcCompactionJob`].
+    /// This option is only used by GC compaction. For the full explanation, see [`compaction::GcCompactJob`].
     pub compact_key_range: Option<CompactKeyRange>,
     /// If set, the compaction will only compact the LSN within this value.
-    /// This option is only used by GC compaction. For the full explanation, see [`GcCompactionJob`].
+    /// This option is only used by GC compaction. For the full explanation, see [`compaction::GcCompactJob`].
     pub compact_lsn_range: Option<CompactLsnRange>,
     /// Enable sub-compaction (split compaction job across key ranges).
     /// This option is only used by GC compaction.

diff --git a/pageserver/src/tenant/timeline/compaction.rs b/pageserver/src/tenant/timeline/compaction.rs
@@ -115,7 +115,7 @@ pub struct GcCompactionJobDescription {
     /// generate an image == this LSN.
     retain_lsns_below_horizon: Vec<Lsn>,
     /// Maximum layer LSN processed in this compaction, that is max(end_lsn of layers). Exclusive. All data
-    /// >= this LSN will be kept and will not be rewritten.
+    /// \>= this LSN will be kept and will not be rewritten.
     max_layer_lsn: Lsn,
     /// Minimum layer LSN processed in this compaction, that is min(start_lsn of layers). Inclusive.
     /// All access below (strict lower than `<`) this LSN will be routed through the normal read path instead of