314 lines
12 KiB
Markdown
314 lines
12 KiB
Markdown
# Glossary
|
||
|
||
- [derivation]{#gloss-derivation}
|
||
|
||
A description of a build task. The result of a derivation is a
|
||
store object. Derivations declared in Nix expressions are specified
|
||
using the [`derivation` primitive](./language/derivations.md). These are
|
||
translated into low-level *store derivations* (implicitly by
|
||
`nix-build`, or explicitly by `nix-instantiate`).
|
||
|
||
[derivation]: #gloss-derivation
|
||
|
||
- [store derivation]{#gloss-store-derivation}
|
||
|
||
A [derivation] represented as a `.drv` file in the [store].
|
||
It has a [store path], like any [store object].
|
||
It is the [instantiated][instantiate] form of a derivation.
|
||
|
||
Example: `/nix/store/g946hcz4c8mdvq2g8vxx42z51qb71rvp-git-2.38.1.drv`
|
||
|
||
See [`nix derivation show`](./command-ref/new-cli/nix3-derivation-show.md) (experimental) for displaying the contents of store derivations.
|
||
|
||
[store derivation]: #gloss-store-derivation
|
||
|
||
- [instantiate]{#gloss-instantiate}, instantiation
|
||
|
||
Save an evaluated [derivation] as a [store derivation] in the Nix [store].
|
||
|
||
See [`nix-instantiate`](./command-ref/nix-instantiate.md), which produces a store derivation from a Nix expression that evaluates to a derivation.
|
||
|
||
[instantiate]: #gloss-instantiate
|
||
|
||
- [realise]{#gloss-realise}, realisation
|
||
|
||
Ensure a [store path] is [valid][validity].
|
||
|
||
This can be achieved by:
|
||
- Fetching a pre-built [store object] from a [substituter]
|
||
- Running the [`builder`](@docroot@/language/derivations.md#attr-builder) executable as specified in the corresponding [derivation]
|
||
- Delegating to a [remote builder](@docroot@/advanced-topics/distributed-builds.html) and retrieving the outputs
|
||
<!-- TODO: link [running] to build process page, #8888 -->
|
||
|
||
See [`nix-store --realise`](@docroot@/command-ref/nix-store/realise.md) for a detailed description of the algorithm.
|
||
|
||
See also [`nix-build`](./command-ref/nix-build.md) and [`nix build`](./command-ref/new-cli/nix3-build.md) (experimental).
|
||
|
||
[realise]: #gloss-realise
|
||
|
||
- [content-addressed derivation]{#gloss-content-addressed-derivation}
|
||
|
||
A derivation which has the
|
||
[`__contentAddressed`](./language/advanced-attributes.md#adv-attr-__contentAddressed)
|
||
attribute set to `true`.
|
||
|
||
- [fixed-output derivation]{#gloss-fixed-output-derivation}
|
||
|
||
A derivation which includes the
|
||
[`outputHash`](./language/advanced-attributes.md#adv-attr-outputHash) attribute.
|
||
|
||
- [store]{#gloss-store}
|
||
|
||
A collection of store objects, with operations to manipulate that collection.
|
||
See [Nix store](./store/index.md) for details.
|
||
|
||
There are many types of stores.
|
||
See [`nix help-stores`](@docroot@/command-ref/new-cli/nix3-help-stores.md) for a complete list.
|
||
|
||
From the perspective of the location where Nix is invoked, the Nix store can be referred to _local_ or _remote_.
|
||
Only a [local store]{#gloss-local-store} exposes a location in the file system of the machine where Nix is invoked that allows access to store objects, typically `/nix/store`.
|
||
Local stores can be used for building [derivations](#gloss-derivation).
|
||
See [Local Store](@docroot@/command-ref/new-cli/nix3-help-stores.md#local-store) for details.
|
||
|
||
[store]: #gloss-store
|
||
[local store]: #gloss-local-store
|
||
|
||
- [chroot store]{#gloss-chroot-store}
|
||
|
||
A [local store] whose canonical path is anything other than `/nix/store`.
|
||
|
||
- [binary cache]{#gloss-binary-cache}
|
||
|
||
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
|
||
[Nix database]. This different format simplifies serving store objects
|
||
over the network, but cannot host builds. Examples of binary caches
|
||
include S3 buckets and the [NixOS binary cache](https://cache.nixos.org).
|
||
|
||
- [store path]{#gloss-store-path}
|
||
|
||
The location of a [store object](@docroot@/store/index.md#store-object) in the file system, i.e., an immediate child of the Nix store directory.
|
||
|
||
> **Example**
|
||
>
|
||
> `/nix/store/a040m110amc4h71lds2jmr8qrkj2jhxd-git-2.38.1`
|
||
|
||
See [Store Path](@docroot@/store/store-path.md) for details.
|
||
|
||
[store path]: #gloss-store-path
|
||
|
||
- [file system object]{#gloss-store-object}
|
||
|
||
The Nix data model for representing simplified file system data.
|
||
|
||
See [File System Object](@docroot@/store/file-system-object.md) for details.
|
||
|
||
[file system object]: #gloss-file-system-object
|
||
|
||
- [store object]{#gloss-store-object}
|
||
|
||
Part of the contents of a [store].
|
||
|
||
A store object consists of a [file system object], [references][reference] to other store objects, and other metadata.
|
||
It can be referred to by a [store path].
|
||
|
||
See [Store Object](@docroot@/store/index.md#store-object) for details.
|
||
|
||
[store object]: #gloss-store-object
|
||
|
||
- [IFD]{#gloss-ifd}
|
||
|
||
[Import From Derivation](./language/import-from-derivation.md)
|
||
|
||
- [input-addressed store object]{#gloss-input-addressed-store-object}
|
||
|
||
A store object produced by building a
|
||
non-[content-addressed](#gloss-content-addressed-derivation),
|
||
non-[fixed-output](#gloss-fixed-output-derivation)
|
||
derivation.
|
||
|
||
- [content-addressed store object]{#gloss-content-addressed-store-object}
|
||
|
||
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).
|
||
|
||
- [substitute]{#gloss-substitute}
|
||
|
||
A substitute is a command invocation stored in the [Nix database] that
|
||
describes how to build a store object, bypassing the normal build
|
||
mechanism (i.e., derivations). Typically, the substitute builds the
|
||
store object by downloading a pre-built version of the store object
|
||
from some server.
|
||
|
||
- [substituter]{#gloss-substituter}
|
||
|
||
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.
|
||
|
||
See the [`substituters` configuration option](./command-ref/conf-file.md#conf-substituters) for details.
|
||
|
||
[substituter]: #gloss-substituter
|
||
|
||
- [purity]{#gloss-purity}
|
||
|
||
The assumption that equal Nix derivations when run always produce
|
||
the same output. This cannot be guaranteed in general (e.g., a
|
||
builder can rely on external inputs such as the network or the
|
||
system time) but the Nix model assumes it.
|
||
|
||
- [impure derivation]{#gloss-impure-derivation}
|
||
|
||
[An experimental feature](#@docroot@/contributing/experimental-features.md#xp-feature-impure-derivations) that allows derivations to be explicitly marked as impure,
|
||
so that they are always rebuilt, and their outputs not reused by subsequent calls to realise them.
|
||
|
||
- [Nix database]{#gloss-nix-database}
|
||
|
||
An SQlite database to track [reference]s between [store object]s.
|
||
This is an implementation detail of the [local store].
|
||
|
||
Default location: `/nix/var/nix/db`.
|
||
|
||
[Nix database]: #gloss-nix-database
|
||
|
||
- [Nix expression]{#gloss-nix-expression}
|
||
|
||
1. Commonly, a high-level description of software packages and compositions
|
||
thereof. Deploying software using Nix entails writing Nix
|
||
expressions for your packages. Nix expressions specify [derivations][derivation],
|
||
which are [instantiated][instantiate] into the Nix store as [store derivations][store derivation].
|
||
These derivations can then be [realised][realise] to produce [outputs][output].
|
||
|
||
2. A syntactically valid use of the [Nix language]. For example, the contents of a `.nix` file form an expression.
|
||
|
||
- [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`.
|
||
|
||
Store objects can refer to both other store objects and themselves.
|
||
References from a store object to itself are called *self-references*.
|
||
References other than a self-reference must not form a cycle.
|
||
|
||
[reference]: #gloss-reference
|
||
|
||
- [reachable]{#gloss-reachable}
|
||
|
||
A store path `Q` is reachable from another store path `P` if `Q`
|
||
is in the *closure* of the *references* relation.
|
||
|
||
- [closure]{#gloss-closure}
|
||
|
||
The closure of a store path is the set of store paths that are
|
||
directly or indirectly “reachable” from that store path; that is,
|
||
it’s the closure of the path under the *references* relation. For
|
||
a package, the closure of its derivation is equivalent to the
|
||
build-time dependencies, while the closure of its output path is
|
||
equivalent to its runtime dependencies. For correct deployment it
|
||
is necessary to deploy whole closures, since otherwise at runtime
|
||
files could be missing. The command `nix-store --query --requisites ` prints out
|
||
closures of store paths.
|
||
|
||
As an example, if the [store object] at path `P` contains a [reference]
|
||
to a store object at path `Q`, then `Q` is in the closure of `P`. Further, if `Q`
|
||
references `R` then `R` is also in the closure of `P`.
|
||
|
||
[closure]: #gloss-closure
|
||
|
||
- [output]{#gloss-output}
|
||
|
||
A [store object] produced by a [derivation].
|
||
See [the `outputs` argument to the `derivation` function](@docroot@/language/derivations.md#attr-outputs) for details.
|
||
|
||
[output]: #gloss-output
|
||
|
||
- [output path]{#gloss-output-path}
|
||
|
||
The [store path] to the [output] of a [derivation].
|
||
|
||
[output path]: #gloss-output-path
|
||
|
||
- [deriver]{#gloss-deriver}
|
||
|
||
The [store derivation] that produced an [output path].
|
||
|
||
The deriver for an output path can be queried with the `--deriver` option to
|
||
[`nix-store --query`](@docroot@/command-ref/nix-store/query.md).
|
||
|
||
- [validity]{#gloss-validity}
|
||
|
||
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.
|
||
|
||
[validity]: #gloss-validity
|
||
|
||
- [user environment]{#gloss-user-env}
|
||
|
||
An automatically generated store object that consists of a set of
|
||
symlinks to “active” applications, i.e., other store paths. These
|
||
are generated automatically by
|
||
[`nix-env`](./command-ref/nix-env.md). See *profiles*.
|
||
|
||
- [profile]{#gloss-profile}
|
||
|
||
A symlink to the current *user environment* of a user, e.g.,
|
||
`/nix/var/nix/profiles/default`.
|
||
|
||
- [installable]{#gloss-installable}
|
||
|
||
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.
|
||
|
||
- [NAR]{#gloss-nar}
|
||
|
||
A *N*ix *AR*chive. This is a serialisation of a path in the Nix
|
||
store. It can contain regular files, directories and symbolic
|
||
links. NARs are generated and unpacked using `nix-store --dump`
|
||
and `nix-store --restore`.
|
||
|
||
- [`∅`]{#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.
|
||
|
||
- [`ε`]{#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.
|
||
|
||
- [package]{#package}
|
||
|
||
1. A software package; a collection of files and other data.
|
||
|
||
2. A [package attribute set].
|
||
|
||
- [package attribute set]{#package-attribute-set}
|
||
|
||
An [attribute set](@docroot@/language/values.md#attribute-set) containing the attribute `type = "derivation";` (derivation for historical reasons), as well as other attributes, such as
|
||
- attributes that refer to the files of a [package], typically in the form of [derivation outputs](#output),
|
||
- attributes that declare something about how the package is supposed to be installed or used,
|
||
- other metadata or arbitrary attributes.
|
||
|
||
[package attribute set]: #package-attribute-set
|
||
|
||
- [string interpolation]{#gloss-string-interpolation}
|
||
|
||
Expanding expressions enclosed in `${ }` within a [string], [path], or [attribute name].
|
||
|
||
See [String interpolation](./language/string-interpolation.md) for details.
|
||
|
||
[string]: ./language/values.md#type-string
|
||
[path]: ./language/values.md#type-path
|
||
[attribute name]: ./language/values.md#attribute-set
|
||
|
||
- [experimental feature]{#gloss-experimental-feature}
|
||
|
||
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.
|
||
|
||
See the contribution guide on the [purpose and lifecycle of experimental feaures](@docroot@/contributing/experimental-features.md).
|
||
|
||
|
||
[Nix language]: ./language/index.md
|