mirror of
https://github.com/privatevoid-net/nix-super.git
synced 2024-11-23 22:46:16 +02:00
Start to document the local-overlay store
This commit is contained in:
parent
6dc9030606
commit
4f5b01f5cd
3 changed files with 15 additions and 8 deletions
|
@ -5,6 +5,13 @@
|
|||
|
||||
namespace nix {
|
||||
|
||||
std::string LocalOverlayStoreConfig::doc()
|
||||
{
|
||||
return
|
||||
#include "local-overlay-store.md"
|
||||
;
|
||||
}
|
||||
|
||||
Path LocalOverlayStoreConfig::toUpperPath(const StorePath & path) {
|
||||
return upperLayer + "/" + path.to_string();
|
||||
}
|
||||
|
|
|
@ -61,14 +61,7 @@ struct LocalOverlayStoreConfig : virtual LocalStoreConfig
|
|||
return ExperimentalFeature::LocalOverlayStore;
|
||||
}
|
||||
|
||||
std::string doc() override
|
||||
{
|
||||
return
|
||||
""
|
||||
// FIXME write docs
|
||||
//#include "local-overlay-store.md"
|
||||
;
|
||||
}
|
||||
std::string doc() override;
|
||||
|
||||
/**
|
||||
* Given a store path, get its location (if it is exists) in the
|
||||
|
|
7
src/libstore/local-overlay-store.md
Normal file
7
src/libstore/local-overlay-store.md
Normal 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.
|
||||
|
||||
)"
|
Loading…
Reference in a new issue