From 56101531c06e1caf76e737b1b07a07a6cc2f7ff7 Mon Sep 17 00:00:00 2001
From: Vlad Lazar <vlad@neon.tech>
Date: Thu, 24 Oct 2024 12:10:27 +0200
Subject: [PATCH] review: add a comment for the types

---
 pageserver/src/walingest.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/pageserver/src/walingest.rs b/pageserver/src/walingest.rs
index 17d8d03159..8a4c0554f8 100644
--- a/pageserver/src/walingest.rs
+++ b/pageserver/src/walingest.rs
@@ -107,6 +107,10 @@ struct WarnIngestLag {
     timestamp_invalid_msg_ratelimit: RateLimit,
 }
 
+// These structs are an intermediary representation of the PostgreSQL WAL records.
+// The ones prefixed with `Xl` are lower level, while the ones that are not have
+// all the required context to be acted upon by the pageserver.
+
 enum HeapamRecord {
     ClearVmBits(ClearVmBits),
 }