Skip to content

Commit

Permalink
simplify description of nix-store --realise
Browse files Browse the repository at this point in the history
according to team review
  • Loading branch information
fricklerhandwerk committed Jan 2, 2023
1 parent 134e957 commit b948da6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 12 deletions.
12 changes: 1 addition & 11 deletions doc/manual/src/command-ref/nix-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,23 +63,13 @@ have an effect.
## Description

Ensure that the given [store path]s are [valid].
A store path is valid if all [store object]s in its [closure] can be read from the store.

If a given path is a [store derivation], the command operates on the [output path]s of that derivation.

If the paths are already valid, we are done immediately.
Otherwise, the associated store objects in the paths' closure may be fetched from [substituter]s.

Finally, if a store derivation was given as argument, the required store objects can be produced by running the associated build task.
If no store derivation is given and no substitutes are available, realisation fails.
If a given path refers to a [store derivation], the command additionally operates on the [output path]s of that derivation.

[store path]: ../glossary.md#gloss-store-path
[valid]: ../glossary.md#gloss-validity
[store object]: ../glossary.md#gloss-store-object
[closure]: ../glossary.md#gloss-closure
[store derivation]: ../glossary.md#gloss-store-derivation
[output path]: ../glossary.md#gloss-output-path
[substituter]: ../glossary.md#gloss-substituter

The output path of each derivation is printed on standard output. For
non-derivations argument, the argument itself is printed.
Expand Down
4 changes: 3 additions & 1 deletion doc/manual/src/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,9 @@
The [store derivation] that produced an [output path].

- [validity]{#gloss-validity}\
A [store path] is *valid* if all of the following hold:
A store path is valid if all [store object]s in its [closure] can be read from the [store].

For a local store, this means:
- The store path leads to an existing [store object] in that [store].
- The store path is listed in the Nix database as being valid.
- All paths in the store path's [closure] are valid.
Expand Down

0 comments on commit b948da6

Please sign in to comment.