mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-06-09 19:13:26 +03:00
closureInfo: write a doc comment
To see it, run `:doc closureInfo `nix repl -f.` on Nix 2.26+.
This commit is contained in:
parent
639aae7e30
commit
8215ed0215
1 changed files with 33 additions and 6 deletions
|
@ -1,15 +1,42 @@
|
|||
# This derivation builds two files containing information about the
|
||||
# closure of 'rootPaths': $out/store-paths contains the paths in the
|
||||
# closure, and $out/registration contains a file suitable for use with
|
||||
# "nix-store --load-db" and "nix-store --register-validity
|
||||
# --hash-given".
|
||||
|
||||
{
|
||||
stdenvNoCC,
|
||||
coreutils,
|
||||
jq,
|
||||
}:
|
||||
|
||||
/**
|
||||
Produces metadata about the closure of the given root paths.
|
||||
|
||||
1. Total NAR size in `$out/total-nar-size`.
|
||||
2. Registration, suitable for `nix-store --load-db`, in `$out/registration`.
|
||||
Can also be used with `nix-store --register-validity --hash-given`.
|
||||
3. All store paths for the closure in `$out/store-paths`.
|
||||
|
||||
# Inputs
|
||||
|
||||
`rootPaths` ([Path])
|
||||
|
||||
: List of root paths to include in the closure information.
|
||||
|
||||
# Type
|
||||
|
||||
```
|
||||
closureInfo :: { rootPaths :: [Path]; } -> Derivation
|
||||
```
|
||||
|
||||
# Examples
|
||||
:::{.example}
|
||||
## `pkgs.closureInfo` usage example
|
||||
```
|
||||
pkgs.closureInfo {
|
||||
rootPaths = [ pkgs.hello pkgs.bc pkgs.dwarf2json ];
|
||||
}
|
||||
=>
|
||||
«derivation /nix/store/...-closure-info.drv»
|
||||
```
|
||||
|
||||
:::
|
||||
*/
|
||||
{ rootPaths }:
|
||||
|
||||
assert builtins.langVersion >= 5;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue