aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src/command-ref/nix-store.md
diff options
context:
space:
mode:
authorValentin Gagarin <valentin.gagarin@tweag.io>2022-12-21 11:39:32 +0100
committerValentin Gagarin <valentin.gagarin@tweag.io>2023-01-03 13:53:53 +0100
commit9cb1610257d9560ab2ba7a57a385de8cf6ca8f40 (patch)
tree23ccaac8ecf3d30c6b06cb1c8f79a218574d467d /doc/manual/src/command-ref/nix-store.md
parent80a0f77e49817a0fdb67109f2a7c3afb2c4e7d9d (diff)
define the terms "realise" and "valid" for store paths
add links to the glossary definition where the terms are used
Diffstat (limited to 'doc/manual/src/command-ref/nix-store.md')
-rw-r--r--doc/manual/src/command-ref/nix-store.md23
1 files changed, 15 insertions, 8 deletions
diff --git a/doc/manual/src/command-ref/nix-store.md b/doc/manual/src/command-ref/nix-store.md
index acf29e4aa..a53d30c46 100644
--- a/doc/manual/src/command-ref/nix-store.md
+++ b/doc/manual/src/command-ref/nix-store.md
@@ -66,11 +66,11 @@ The operation `--realise` essentially “builds” the specified store
paths. Realisation is a somewhat overloaded term:
- If the store path is a *derivation*, realisation ensures that the
- output paths of the derivation are [valid](../glossary.md) (i.e.,
+ output paths of the derivation are [valid] (i.e.,
the output path and its closure exist in the file system). This
can be done in several ways. First, it is possible that the
outputs are already valid, in which case we are done
- immediately. Otherwise, there may be [substitutes](../glossary.md)
+ immediately. Otherwise, there may be [substitutes]
that produce the outputs (e.g., by downloading them). Finally, the
outputs can be produced by running the build task described
by the derivation.
@@ -82,6 +82,9 @@ paths. Realisation is a somewhat overloaded term:
produced through substitutes. If there are no (successful)
substitutes, realisation fails.
+[valid]: ../glossary.md#validity
+[substitutes]: ../glossary.md#substitute
+
The output path of each derivation is printed on standard output. (For
non-derivations argument, the argument itself is printed.)
@@ -289,8 +292,8 @@ error: cannot delete path `/nix/store/zq0h41l75vlb4z45kzgjjmsjxvcv1qk7-mesa-6.4'
## Description
-The operation `--query` displays various bits of information about the
-store paths . The queries are described below. At most one query can be
+The operation `--query` displays information about [store path]s.
+The queries are described below. At most one query can be
specified. The default query is `--outputs`.
The paths *paths* may also be symlinks from outside of the Nix store, to
@@ -310,12 +313,12 @@ symlink.
## Queries
- `--outputs`\
- Prints out the [output paths](../glossary.md) of the store
+ Prints out the [output path]s of the store
derivations *paths*. These are the paths that will be produced when
the derivation is built.
- `--requisites`; `-R`\
- Prints out the [closure](../glossary.md) of the store path *paths*.
+ Prints out the [closure] of the given *paths*.
This query has one option:
@@ -332,10 +335,12 @@ symlink.
derivation and specifying the option `--include-outputs`.
- `--references`\
- Prints the set of [references](../glossary.md) of the store paths
+ Prints the set of [references]s of the store paths
*paths*, that is, their immediate dependencies. (For *all*
dependencies, use `--requisites`.)
+ [reference]: ../glossary.md#gloss-reference
+
- `--referrers`\
Prints the set of *referrers* of the store paths *paths*, that is,
the store paths currently existing in the Nix store that refer to
@@ -350,11 +355,13 @@ symlink.
in the Nix store that are dependent on *paths*.
- `--deriver`; `-d`\
- Prints the [deriver](../glossary.md) of the store paths *paths*. If
+ Prints the [deriver] of the store paths *paths*. If
the path has no deriver (e.g., if it is a source file), or if the
deriver is not known (e.g., in the case of a binary-only
deployment), the string `unknown-deriver` is printed.
+ [deriver]: ../glossary.md#gloss-deriver
+
- `--graph`\
Prints the references graph of the store paths *paths* in the format
of the `dot` tool of AT\&T's [Graphviz