scriptis/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

glossary: dedent list and do not use forced line breaks

Browse source 
this makes it slightly easier to work with and consistent with all the
other markdown lists in use
This commit is contained in:
Valentin Gagarin 2023-08-24 10:00:17 +02:00
parent 4a435ad228
commit d5b130ef13
1 changed files with 200 additions and 167 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

99
doc/manual/src/glossary.md
View file

@ -1,6 +1,7 @@
# Glossary # Glossary
- [derivation]{#gloss-derivation}\ - [derivation]{#gloss-derivation}
A description of a build task. The result of a derivation is a A description of a build task. The result of a derivation is a
store object. Derivations are typically specified in Nix expressions store object. Derivations are typically specified in Nix expressions
using the [`derivation` primitive](./language/derivations.md). These are using the [`derivation` primitive](./language/derivations.md). These are
@ -9,7 +10,8 @@
[derivation]: #gloss-derivation [derivation]: #gloss-derivation
- [store derivation]{#gloss-store-derivation}\ - [store derivation]{#gloss-store-derivation}
A [derivation] represented as a `.drv` file in the [store]. A [derivation] represented as a `.drv` file in the [store].
It has a [store path], like any [store object]. It has a [store path], like any [store object].
@ -19,14 +21,16 @@
[store derivation]: #gloss-store-derivation [store derivation]: #gloss-store-derivation
- [instantiate]{#gloss-instantiate}, instantiation\ - [instantiate]{#gloss-instantiate}, instantiation
Translate a [derivation] into a [store derivation]. Translate a [derivation] into a [store derivation].
See [`nix-instantiate`](./command-ref/nix-instantiate.md). See [`nix-instantiate`](./command-ref/nix-instantiate.md).
[instantiate]: #gloss-instantiate [instantiate]: #gloss-instantiate
- [realise]{#gloss-realise}, realisation\ - [realise]{#gloss-realise}, realisation
Ensure a [store path] is [valid][validity]. Ensure a [store path] is [valid][validity].
This means either running the `builder` executable as specified in the corresponding [derivation] or fetching a pre-built [store object] from a [substituter]. This means either running the `builder` executable as specified in the corresponding [derivation] or fetching a pre-built [store object] from a [substituter].
@ -37,16 +41,19 @@
[realise]: #gloss-realise [realise]: #gloss-realise
- [content-addressed derivation]{#gloss-content-addressed-derivation}\ - [content-addressed derivation]{#gloss-content-addressed-derivation}
A derivation which has the A derivation which has the
[`__contentAddressed`](./language/advanced-attributes.md#adv-attr-__contentAddressed) [`__contentAddressed`](./language/advanced-attributes.md#adv-attr-__contentAddressed)
attribute set to `true`. attribute set to `true`.
- [fixed-output derivation]{#gloss-fixed-output-derivation}\ - [fixed-output derivation]{#gloss-fixed-output-derivation}
A derivation which includes the A derivation which includes the
[`outputHash`](./language/advanced-attributes.md#adv-attr-outputHash) attribute. [`outputHash`](./language/advanced-attributes.md#adv-attr-outputHash) attribute.
- [store]{#gloss-store}\ - [store]{#gloss-store}
The location in the file system where store objects live. Typically The location in the file system where store objects live. Typically
`/nix/store`. `/nix/store`.
@ -67,17 +74,20 @@
[store]: #gloss-store [store]: #gloss-store
[local store]: #gloss-local-store [local store]: #gloss-local-store
- [chroot store]{#gloss-chroot-store}\ - [chroot store]{#gloss-chroot-store}
A [local store] whose canonical path is anything other than `/nix/store`. A [local store] whose canonical path is anything other than `/nix/store`.
- [binary cache]{#gloss-binary-cache}\ - [binary cache]{#gloss-binary-cache}
A *binary cache* is a Nix store which uses a different format: its A *binary cache* is a Nix store which uses a different format: its
metadata and signatures are kept in `.narinfo` files rather than in a metadata and signatures are kept in `.narinfo` files rather than in a
[Nix database]. This different format simplifies serving store objects [Nix database]. This different format simplifies serving store objects
over the network, but cannot host builds. Examples of binary caches over the network, but cannot host builds. Examples of binary caches
include S3 buckets and the [NixOS binary cache](https://cache.nixos.org). include S3 buckets and the [NixOS binary cache](https://cache.nixos.org).
- [store path]{#gloss-store-path}\ - [store path]{#gloss-store-path}
The location of a [store object] in the file system, i.e., an The location of a [store object] in the file system, i.e., an
immediate child of the Nix store directory. immediate child of the Nix store directory.
@ -85,38 +95,44 @@
[store path]: #gloss-store-path [store path]: #gloss-store-path
- [file system object]{#gloss-store-object}\ - [file system object]{#gloss-store-object}
The Nix data model for representing simplified file system data. The Nix data model for representing simplified file system data.
See [File System Object](@docroot@/architecture/file-system-object.md) for details. See [File System Object](@docroot@/architecture/file-system-object.md) for details.
[file system object]: #gloss-file-system-object [file system object]: #gloss-file-system-object
- [store object]{#gloss-store-object}\ - [store object]{#gloss-store-object}
A store object consists of a [file system object], [reference]s to other store objects, and other metadata. A store object consists of a [file system object], [reference]s to other store objects, and other metadata.
It can be referred to by a [store path]. It can be referred to by a [store path].
[store object]: #gloss-store-object [store object]: #gloss-store-object
- [input-addressed store object]{#gloss-input-addressed-store-object}\ - [input-addressed store object]{#gloss-input-addressed-store-object}
A store object produced by building a A store object produced by building a
non-[content-addressed](#gloss-content-addressed-derivation), non-[content-addressed](#gloss-content-addressed-derivation),
non-[fixed-output](#gloss-fixed-output-derivation) non-[fixed-output](#gloss-fixed-output-derivation)
derivation. derivation.
- [output-addressed store object]{#gloss-output-addressed-store-object}\ - [output-addressed store object]{#gloss-output-addressed-store-object}
A [store object] whose [store path] is determined by its contents. A [store object] whose [store path] is determined by its contents.
This includes derivations, the outputs of [content-addressed derivations](#gloss-content-addressed-derivation), and the outputs of [fixed-output derivations](#gloss-fixed-output-derivation). This includes derivations, the outputs of [content-addressed derivations](#gloss-content-addressed-derivation), and the outputs of [fixed-output derivations](#gloss-fixed-output-derivation).
- [substitute]{#gloss-substitute}\ - [substitute]{#gloss-substitute}
A substitute is a command invocation stored in the [Nix database] that A substitute is a command invocation stored in the [Nix database] that
describes how to build a store object, bypassing the normal build describes how to build a store object, bypassing the normal build
mechanism (i.e., derivations). Typically, the substitute builds the mechanism (i.e., derivations). Typically, the substitute builds the
store object by downloading a pre-built version of the store object store object by downloading a pre-built version of the store object
from some server. from some server.
- [substituter]{#gloss-substituter}\ - [substituter]{#gloss-substituter}
An additional [store]{#gloss-store} from which Nix can obtain store objects instead of building them. An additional [store]{#gloss-store} from which Nix can obtain store objects instead of building them.
Often the substituter is a [binary cache](#gloss-binary-cache), but any store can serve as substituter. Often the substituter is a [binary cache](#gloss-binary-cache), but any store can serve as substituter.
@ -124,13 +140,15 @@
[substituter]: #gloss-substituter [substituter]: #gloss-substituter
- [purity]{#gloss-purity}\ - [purity]{#gloss-purity}
The assumption that equal Nix derivations when run always produce The assumption that equal Nix derivations when run always produce
the same output. This cannot be guaranteed in general (e.g., a the same output. This cannot be guaranteed in general (e.g., a
builder can rely on external inputs such as the network or the builder can rely on external inputs such as the network or the
system time) but the Nix model assumes it. system time) but the Nix model assumes it.
- [Nix database]{#gloss-nix-database}\ - [Nix database]{#gloss-nix-database}
An SQlite database to track [reference]s between [store object]s. An SQlite database to track [reference]s between [store object]s.
This is an implementation detail of the [local store]. This is an implementation detail of the [local store].
@ -138,14 +156,16 @@
[Nix database]: #gloss-nix-database [Nix database]: #gloss-nix-database
- [Nix expression]{#gloss-nix-expression}\ - [Nix expression]{#gloss-nix-expression}
A high-level description of software packages and compositions A high-level description of software packages and compositions
thereof. Deploying software using Nix entails writing Nix thereof. Deploying software using Nix entails writing Nix
expressions for your packages. Nix expressions are translated to expressions for your packages. Nix expressions are translated to
derivations that are stored in the Nix store. These derivations can derivations that are stored in the Nix store. These derivations can
then be built. then be built.
- [reference]{#gloss-reference}\ - [reference]{#gloss-reference}
A [store object] `O` is said to have a *reference* to a store object `P` if a [store path] to `P` appears in the contents of `O`. A [store object] `O` is said to have a *reference* to a store object `P` if a [store path] to `P` appears in the contents of `O`.
Store objects can refer to both other store objects and themselves. Store objects can refer to both other store objects and themselves.
@ -154,11 +174,13 @@
[reference]: #gloss-reference [reference]: #gloss-reference
- [reachable]{#gloss-reachable}\ - [reachable]{#gloss-reachable}
A store path `Q` is reachable from another store path `P` if `Q` A store path `Q` is reachable from another store path `P` if `Q`
is in the *closure* of the *references* relation. is in the *closure* of the *references* relation.
- [closure]{#gloss-closure}\ - [closure]{#gloss-closure}
The closure of a store path is the set of store paths that are The closure of a store path is the set of store paths that are
directly or indirectly “reachable” from that store path; that is, directly or indirectly “reachable” from that store path; that is,
it’s the closure of the path under the *references* relation. For it’s the closure of the path under the *references* relation. For
@ -175,15 +197,18 @@
[closure]: #gloss-closure [closure]: #gloss-closure
- [output path]{#gloss-output-path}\ - [output path]{#gloss-output-path}
A [store path] produced by a [derivation]. A [store path] produced by a [derivation].
[output path]: #gloss-output-path [output path]: #gloss-output-path
- [deriver]{#gloss-deriver}\ - [deriver]{#gloss-deriver}
The [store derivation] that produced an [output path]. The [store derivation] that produced an [output path].
- [validity]{#gloss-validity}\ - [validity]{#gloss-validity}
A store path is valid if all [store object]s in its [closure] can be read from the [store]. 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: For a [local store], this means:
@ -193,34 +218,41 @@
[validity]: #gloss-validity [validity]: #gloss-validity
- [user environment]{#gloss-user-env}\ - [user environment]{#gloss-user-env}
An automatically generated store object that consists of a set of An automatically generated store object that consists of a set of
symlinks to “active” applications, i.e., other store paths. These symlinks to “active” applications, i.e., other store paths. These
are generated automatically by are generated automatically by
[`nix-env`](./command-ref/nix-env.md). See *profiles*. [`nix-env`](./command-ref/nix-env.md). See *profiles*.
- [profile]{#gloss-profile}\ - [profile]{#gloss-profile}
A symlink to the current *user environment* of a user, e.g., A symlink to the current *user environment* of a user, e.g.,
`/nix/var/nix/profiles/default`. `/nix/var/nix/profiles/default`.
- [installable]{#gloss-installable}\ - [installable]{#gloss-installable}
Something that can be realised in the Nix store. Something that can be realised in the Nix store.
See [installables](./command-ref/new-cli/nix.md#installables) for [`nix` commands](./command-ref/new-cli/nix.md) (experimental) for details. See [installables](./command-ref/new-cli/nix.md#installables) for [`nix` commands](./command-ref/new-cli/nix.md) (experimental) for details.
- [NAR]{#gloss-nar}\ - [NAR]{#gloss-nar}
A *N*ix *AR*chive. This is a serialisation of a path in the Nix A *N*ix *AR*chive. This is a serialisation of a path in the Nix
store. It can contain regular files, directories and symbolic store. It can contain regular files, directories and symbolic
links. NARs are generated and unpacked using `nix-store --dump` links. NARs are generated and unpacked using `nix-store --dump`
and `nix-store --restore`. and `nix-store --restore`.
- [`∅`]{#gloss-emtpy-set}\ - [`∅`]{#gloss-emtpy-set}
The empty set symbol. In the context of profile history, this denotes a package is not present in a particular version of the profile. The empty set symbol. In the context of profile history, this denotes a package is not present in a particular version of the profile.
- [`ε`]{#gloss-epsilon}\ - [`ε`]{#gloss-epsilon}
The epsilon symbol. In the context of a package, this means the version is empty. More precisely, the derivation does not have a version attribute. The epsilon symbol. In the context of a package, this means the version is empty. More precisely, the derivation does not have a version attribute.
- [string interpolation]{#gloss-string-interpolation}\ - [string interpolation]{#gloss-string-interpolation}
Expanding expressions enclosed in `${ }` within a [string], [path], or [attribute name]. Expanding expressions enclosed in `${ }` within a [string], [path], or [attribute name].
See [String interpolation](./language/string-interpolation.md) for details. See [String interpolation](./language/string-interpolation.md) for details.
@ -229,7 +261,8 @@
[path]: ./language/values.md#type-path [path]: ./language/values.md#type-path
[attribute name]: ./language/values.md#attribute-set [attribute name]: ./language/values.md#attribute-set
- [experimental feature]{#gloss-experimental-feature}\ - [experimental feature]{#gloss-experimental-feature}
Not yet stabilized functionality guarded by named experimental feature flags. Not yet stabilized functionality guarded by named experimental feature flags.
These flags are enabled or disabled with the [`experimental-features`](./command-ref/conf-file.html#conf-experimental-features) setting. These flags are enabled or disabled with the [`experimental-features`](./command-ref/conf-file.html#conf-experimental-features) setting.