From b24df97a116731dafbb0bcbcfa795aa07d90258f Mon Sep 17 00:00:00 2001 From: Sergei Zimmerman Date: Tue, 20 Jan 2026 02:39:12 +0300 Subject: [PATCH] binary-cache-store: Update compression setting documentation to match reality The docs were out of date. Since 8a0c00b85600991cdb9aa05902defec6ac44b777 Nix supports all compression algorithms exposed by libarchive (if it's built with native support for them). Let's be honest about it in the docs. --- src/libstore/include/nix/store/binary-cache-store.hh | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/libstore/include/nix/store/binary-cache-store.hh b/src/libstore/include/nix/store/binary-cache-store.hh index 80c0bc9d0..9ec209d8c 100644 --- a/src/libstore/include/nix/store/binary-cache-store.hh +++ b/src/libstore/include/nix/store/binary-cache-store.hh @@ -19,7 +19,13 @@ struct BinaryCacheStoreConfig : virtual StoreConfig using StoreConfig::StoreConfig; const Setting compression{ - this, "xz", "compression", "NAR compression method (`xz`, `bzip2`, `gzip`, `zstd`, or `none`)."}; + this, + "xz", + "compression", + R"( + NAR compression method. One of: `xz`, `bzip2`, `gzip`, `zstd`, `none`, `br`, `compress`, `grzip`, `lrzip`, `lz4`, `lzip`, `lzma` or `lzop`. + To use a particular compression method Nix has to be built with a version of libarchive that natively supports that compression algorithm. + )"}; const Setting writeNARListing{ this, false, "write-nar-listing", "Whether to write a JSON file that lists the files in each NAR."};