NixOS/nix

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

Open

#13,303 建立於 2025年5月31日

在 GitHub 查看
 (1 留言) (1 反應) (0 負責人)C++ (9,803 star) (1,293 fork)batch import
documentationgood first issue

描述

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

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic Nix usagemarkdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
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.