doc: add nix-cache-info format documentation#15006
Merged
edolstra merged 1 commit intoNixOS:masterfrom Jan 19, 2026
Merged
Conversation
edolstra
approved these changes
Jan 16, 2026
| error: binary cache 'https://example.com' is for Nix stores with prefix '/nix/store', not '/home/user/nix/store' | ||
| ``` | ||
|
|
||
| If `nix-cache-info` is missing, Nix attempts to create one with only `StoreDir` set. |
Member
There was a problem hiding this comment.
This line should probably be somewhere else (e.g. at the top of this file or in a section about creating nix-cache-info).
Member
Author
There was a problem hiding this comment.
Moved outside the protocols part, to binary-cache-substituter.md
Document the nix-cache-info file format used by binary caches, including the StoreDir, WantMassQuery, and Priority fields, their behavior, and links to related store options.
roberth
force-pushed
the
doc-nix-cache-info
branch
from
6ad3178 to
b3df7f8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document the nix-cache-info file format used by binary caches, including the StoreDir, WantMassQuery, and Priority fields, their behavior, and links to related store options.
Motivation
Context
Add 👍 to pull requests you find important.
The Nix maintainer team uses a GitHub project board to schedule and track reviews.