From c01c31d045f6eba809ecd04fcd3ce6249d0f85d8 Mon Sep 17 00:00:00 2001
From: Konstantin Knizhnik <knizhnik@garret.ru>
Date: Wed, 22 Feb 2023 22:44:14 +0200
Subject: [PATCH] Add comment exlaining wanted_image_layers

---
 pageserver/src/tenant/timeline.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/pageserver/src/tenant/timeline.rs b/pageserver/src/tenant/timeline.rs
index 972e8f130b..d0be5dfa43 100644
--- a/pageserver/src/tenant/timeline.rs
+++ b/pageserver/src/tenant/timeline.rs
@@ -121,6 +121,14 @@ pub struct Timeline {
     pub pg_version: u32,
 
     pub(super) layers: RwLock<LayerMap<dyn PersistentLayer>>,
+
+    //
+    // Set of key ranges which should be covered by image layers to
+    // allow GC to remove old layers. BTreeMap key is start of range (inclusive),
+    // value - end of range (exclusive). This map is constructed by GC
+    // (when it can not remove layer because it is not covered by image layers)
+    // and used by compaction when it checks if new image layer should be created.
+    //
     wanted_image_layers: Mutex<Option<BTreeMap<Key, Key>>>,
 
     last_freeze_at: AtomicLsn,