From 66eb081876833f2a50d6a24ac8ac3fa7c397f6f2 Mon Sep 17 00:00:00 2001
From: Heikki Linnakangas <heikki@zenith.tech>
Date: Mon, 25 Oct 2021 16:34:13 +0300
Subject: [PATCH] Improve comment on 'base_dir'

---
 control_plane/src/local_env.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/control_plane/src/local_env.rs b/control_plane/src/local_env.rs
index 50fa012096..ce340cb198 100644
--- a/control_plane/src/local_env.rs
+++ b/control_plane/src/local_env.rs
@@ -24,6 +24,10 @@ pub struct LocalEnv {
     pub pageserver_http_port: u16,
 
     // Base directory for both pageserver and compute nodes
+    //
+    // This is not stored in the config file. Rather, this is the path where the
+    // config file itself is. It is read from the ZENITH_REPO_DIR env variable or
+    // '.zenith' if not given.
     pub base_data_dir: PathBuf,
 
     // Path to postgres distribution. It's expected that "bin", "include",