NixOS/nix

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

Open

#13,303 opened on May 31, 2025

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

Repository metrics

Stars
 (9,803 stars)
PR merge metrics
 (Avg merge 7d 11h) (83 merged PRs in 30d)

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

Research direction
Read the source code of nix store register validity and document its behavior and file format.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80