1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-12-08 18:11: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:
Bernardo Meurer 2025-12-04 22:30:27 -05:00
parent a595348f7c
commit c5ed22dd41
No known key found for this signature in database

View file

@ -454,11 +454,9 @@ std::string S3BinaryCacheStoreConfig::getHumanReadableURI() const
std::string S3BinaryCacheStoreConfig::doc()
{
return R"(
**Store URL format**: `s3://bucket-name`
This store allows reading and writing a binary cache stored in an AWS S3 bucket.
)";
return
#include "s3-binary-cache-store.md"
;
}
ref<Store> S3BinaryCacheStoreConfig::openStore() const