diff --git a/src/libstore/local-overlay-store.cc b/src/libstore/local-overlay-store.cc index 4ba98a02d..73902e9ba 100644 --- a/src/libstore/local-overlay-store.cc +++ b/src/libstore/local-overlay-store.cc @@ -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(); } diff --git a/src/libstore/local-overlay-store.hh b/src/libstore/local-overlay-store.hh index 44f0c77c8..e3fda2f93 100644 --- a/src/libstore/local-overlay-store.hh +++ b/src/libstore/local-overlay-store.hh @@ -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 diff --git a/src/libstore/local-overlay-store.md b/src/libstore/local-overlay-store.md new file mode 100644 index 000000000..0b8a1786b --- /dev/null +++ b/src/libstore/local-overlay-store.md @@ -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. + +)"