mirror of
https://github.com/NixOS/nix.git
synced 2025-12-09 10:31:02 +01:00
fix(libstore/s3-binary-cache-store): include documentation from markdown file
The S3BinaryCacheStoreConfig::doc() function was returning a minimal hardcoded 3-line string instead of including the comprehensive documentation from s3-binary-cache-store.md. This was introduced in PR #13752 which moved the prose documentation to the markdown file but forgot to update the doc() function to use it.
This commit is contained in:
parent
a595348f7c
commit
c5ed22dd41
1 changed files with 3 additions and 5 deletions
|
|
@ -454,11 +454,9 @@ std::string S3BinaryCacheStoreConfig::getHumanReadableURI() const
|
||||||
|
|
||||||
std::string S3BinaryCacheStoreConfig::doc()
|
std::string S3BinaryCacheStoreConfig::doc()
|
||||||
{
|
{
|
||||||
return R"(
|
return
|
||||||
**Store URL format**: `s3://bucket-name`
|
#include "s3-binary-cache-store.md"
|
||||||
|
;
|
||||||
This store allows reading and writing a binary cache stored in an AWS S3 bucket.
|
|
||||||
)";
|
|
||||||
}
|
}
|
||||||
|
|
||||||
ref<Store> S3BinaryCacheStoreConfig::openStore() const
|
ref<Store> S3BinaryCacheStoreConfig::openStore() const
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue