From b3bdd70ea2a69ec2ddd547ee475219f5b38b8f59 Mon Sep 17 00:00:00 2001
From: John Ericson <John.Ericson@Obsidian.Systems>
Date: Mon, 11 Dec 2023 13:43:17 -0500
Subject: [PATCH] Clarify `toUpperPath` docs

We're just mapping store paths to host OS paths, there is no checking
what is actually at this location.
---
 src/libstore/local-overlay-store.hh | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/libstore/local-overlay-store.hh b/src/libstore/local-overlay-store.hh
index a93b069cc..2c24285dd 100644
--- a/src/libstore/local-overlay-store.hh
+++ b/src/libstore/local-overlay-store.hh
@@ -62,8 +62,12 @@ struct LocalOverlayStoreConfig : virtual LocalStoreConfig
 
 protected:
     /**
-     * Given a store path, get its location (if it is exists) in the
-     * upper layer of the overlayfs.
+     * @return The host OS path corresponding to the store path for the
+     * upper layer.
+     *
+     * @note The there is no guarantee a store object is actually stored
+     * at that file path. It might be stored in the lower layer instead,
+     * or it might not be part of this store at all.
      */
     Path toUpperPath(const StorePath & path);
 };