max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-14 10:16:15 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Start to document the local-overlay store

Browse source
This commit is contained in:
John Ericson 2023-08-03 11:59:04 -04:00
parent 6dc9030606
commit 4f5b01f5cd
3 changed files with 15 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/libstore/local-overlay-store.cc
View file

@ -5,6 +5,13 @@
namespace nix { namespace nix {
std::string LocalOverlayStoreConfig::doc()
{
return
#include "local-overlay-store.md"
;
}
Path LocalOverlayStoreConfig::toUpperPath(const StorePath & path) { Path LocalOverlayStoreConfig::toUpperPath(const StorePath & path) {
return upperLayer + "/" + path.to_string(); return upperLayer + "/" + path.to_string();
} }

9
src/libstore/local-overlay-store.hh
View file

@ -61,14 +61,7 @@ struct LocalOverlayStoreConfig : virtual LocalStoreConfig
return ExperimentalFeature::LocalOverlayStore; return ExperimentalFeature::LocalOverlayStore;
} }
std::string doc() override std::string doc() override;
{
return
""
// FIXME write docs
//#include "local-overlay-store.md"
;
}
/** /**
* Given a store path, get its location (if it is exists) in the * Given a store path, get its location (if it is exists) in the

7
src/libstore/local-overlay-store.md Normal file
View file

@ -0,0 +1,7 @@
R"(
**Store URL format**: `local-overlay`
This store type is a variation of the [local store](#local-store) designed to leverage overlayfs.
)"