NixOS/nix

`nix-store --register-validity` is undocumented

Open

#13303 opened on May 31, 2025

View on GitHub
 (1 comment) (1 reaction) (0 assignees)C++ (9,803 stars) (1,293 forks)batch import
documentationgood first issue

Description

The command nix-store --register-validity which is only referenced to in the documentation of exportReferencesGraph is completely undocumented https://nix.dev/manual/nix/2.26/language/advanced-attributes#adv-attr-exportReferencesGraph

This means that the file format that https://nix.dev/manual/nix/2.26/language/advanced-attributes#adv-attr-exportReferencesGraph generates is fully undocumented too.

We should document the nix-store --register-validity command.

Originally posted by @arianvp in #10279

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Nix usagemarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the `nix store register validity` command by looking at the Nix source code, likely in src/nix store.cc, to understand its usage, options, and output format. Then document it in the nix store man page (e.g., man/nix store.md). Ensure consistency with the existing documentation of exportReferencesGraph as noted in the issue.