From be4999713a851e2f005cb65c5bd755f5be9eafcf Mon Sep 17 00:00:00 2001
From: Alex Chi <chi@neon.tech>
Date: Tue, 27 Jun 2023 16:54:51 -0400
Subject: [PATCH] add comments for LayerCache

Signed-off-by: Alex Chi <chi@neon.tech>
---
 pageserver/src/tenant/layer_cache.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pageserver/src/tenant/layer_cache.rs b/pageserver/src/tenant/layer_cache.rs
index 972573943c..7316df8992 100644
--- a/pageserver/src/tenant/layer_cache.rs
+++ b/pageserver/src/tenant/layer_cache.rs
@@ -6,6 +6,9 @@ use anyhow::Result;
 use std::sync::{Mutex, Weak};
 use std::{collections::HashMap, sync::Arc};
 
+/// LayerCache is meant to facilitate mapping to/from whatever `PersistentLayerDesc` to an actual in-memory layer
+/// object. In the future, operations that do not modify layer map (i.e., eviction and download) will be implemented
+/// here.
 pub struct LayerCache {
     /// Layer removal lock.
     /// A lock to ensure that no layer of the timeline is removed concurrently by other tasks.