Clarify toUpperPath docs

We're just mapping store paths to host OS paths, there is no checking
what is actually at this location.
This commit is contained in:
John Ericson 2023-12-11 13:43:17 -05:00
parent c93f78f6fa
commit b3bdd70ea2

View file

@ -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);
};