diff --git a/doc/manual/src/glossary.md b/doc/manual/src/glossary.md index 07891175a4e..88bb6e76538 100644 --- a/doc/manual/src/glossary.md +++ b/doc/manual/src/glossary.md @@ -21,6 +21,30 @@ [store derivation]: #gloss-store-derivation +- [store derivation output reference]{#gloss-store-derivation-output-reference} + + The string resulting from the concatenation of: + + - The path to a [store derivation](#gloss-store-derivation) + - The character `^` + - Either: + - one of the store derivation's [output names](#gloss-output-name) or + - the character `*` denoting all outputs of the derivation + + > **Example** + > + > Reference to all outputs of a given `stdenv-linux` derivation: + > + > `/nix/store/xvni94ndxy75v1wdpshk8k0l75nwyc54-stdenv-linux.drv^*` + + > **Example** + > + > Reference to the `man` output of a given `bash-5.2-p15` derivation: + > + > `/nix/store/llil5bng8p7203l25mqb5lwdhlaya4d9-bash-5.2-p15.drv^man` + + [store derivation output reference]: #gloss-store-derivation-output-reference + - [instantiate]{#gloss-instantiate}, instantiation Translate a [derivation] into a [store derivation]. @@ -212,6 +236,11 @@ [output]: #gloss-output +- [output name]{#gloss-output-name} + + A string identifier, such as `out` or `man`, given to each output of a derivation. + See [the `outputs` argument to the `derivation` function](@docroot@/language/derivations.md#attr-outputs) for details; the `outputs` argument is a list and each element of this list is an output name. + - [output path]{#gloss-output-path} The [store path] to the [output] of a [derivation]. diff --git a/src/nix/nix.md b/src/nix/nix.md index eb150f03b41..76f754cdacf 100644 --- a/src/nix/nix.md +++ b/src/nix/nix.md @@ -59,6 +59,7 @@ These are command line arguments that represent something that can be realised i The following types of installable are supported by most commands: - [Flake output attribute](#flake-output-attribute) (experimental) +- [Store derivation output reference](@docroot@/glossary.md#gloss-store-derivation-output-reference) - [Store path](#store-path) - [Nix file](#nix-file), optionally qualified by an attribute path - [Nix expression](#nix-expression), optionally qualified by an attribute path