mirror of
https://github.com/privatevoid-net/nix-super.git
synced 2024-11-25 23:36:16 +02:00
docs: Refer to the glossary with @docroot@
instead of ..
These unweildy relative paths probably predate the `@docroot@` mechanism.
This commit is contained in:
parent
13c2005e7d
commit
95ae12b607
14 changed files with 20 additions and 20 deletions
|
@ -69,7 +69,7 @@ It can also execute build plans to produce new data, which are made available to
|
||||||
A build plan itself is a series of *build tasks*, together with their build inputs.
|
A build plan itself is a series of *build tasks*, together with their build inputs.
|
||||||
|
|
||||||
> **Important**
|
> **Important**
|
||||||
> A build task in Nix is called [derivation](../glossary.md#gloss-derivation).
|
> A build task in Nix is called [derivation](@docroot@/glossary.md#gloss-derivation).
|
||||||
|
|
||||||
Each build task has a special build input executed as *build instructions* in order to perform the build.
|
Each build task has a special build input executed as *build instructions* in order to perform the build.
|
||||||
The result of a build task can be input to another build task.
|
The result of a build task can be input to another build task.
|
||||||
|
|
|
@ -41,7 +41,7 @@ expression to a low-level [store derivation]) and [`nix-store
|
||||||
--realise`](@docroot@/command-ref/nix-store/realise.md) (to build the store
|
--realise`](@docroot@/command-ref/nix-store/realise.md) (to build the store
|
||||||
derivation).
|
derivation).
|
||||||
|
|
||||||
[store derivation]: ../glossary.md#gloss-store-derivation
|
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
|
||||||
|
|
||||||
> **Warning**
|
> **Warning**
|
||||||
>
|
>
|
||||||
|
|
|
@ -49,7 +49,7 @@ authentication, you can avoid typing the passphrase with `ssh-agent`.
|
||||||
- `--include-outputs`\
|
- `--include-outputs`\
|
||||||
Also copy the outputs of [store derivation]s included in the closure.
|
Also copy the outputs of [store derivation]s included in the closure.
|
||||||
|
|
||||||
[store derivation]: ../glossary.md#gloss-store-derivation
|
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
|
||||||
|
|
||||||
- `--use-substitutes` / `-s`\
|
- `--use-substitutes` / `-s`\
|
||||||
Attempt to download missing paths on the target machine using Nix’s
|
Attempt to download missing paths on the target machine using Nix’s
|
||||||
|
|
|
@ -23,7 +23,7 @@ It evaluates the Nix expressions in each of *files* (which defaults to
|
||||||
derivation, a list of derivations, or a set of derivations. The paths
|
derivation, a list of derivations, or a set of derivations. The paths
|
||||||
of the resulting store derivations are printed on standard output.
|
of the resulting store derivations are printed on standard output.
|
||||||
|
|
||||||
[store derivation]: ../glossary.md#gloss-store-derivation
|
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
|
||||||
|
|
||||||
If *files* is the character `-`, then a Nix expression will be read from
|
If *files* is the character `-`, then a Nix expression will be read from
|
||||||
standard input.
|
standard input.
|
||||||
|
|
|
@ -40,12 +40,12 @@ symlink.
|
||||||
derivations *paths*. These are the paths that will be produced when
|
derivations *paths*. These are the paths that will be produced when
|
||||||
the derivation is built.
|
the derivation is built.
|
||||||
|
|
||||||
[output paths]: ../../glossary.md#gloss-output-path
|
[output paths]: @docroot@/glossary.md#gloss-output-path
|
||||||
|
|
||||||
- `--requisites`; `-R`\
|
- `--requisites`; `-R`\
|
||||||
Prints out the [closure] of the store path *paths*.
|
Prints out the [closure] of the store path *paths*.
|
||||||
|
|
||||||
[closure]: ../../glossary.md#gloss-closure
|
[closure]: @docroot@/glossary.md#gloss-closure
|
||||||
|
|
||||||
This query has one option:
|
This query has one option:
|
||||||
|
|
||||||
|
@ -66,7 +66,7 @@ symlink.
|
||||||
*paths*, that is, their immediate dependencies. (For *all*
|
*paths*, that is, their immediate dependencies. (For *all*
|
||||||
dependencies, use `--requisites`.)
|
dependencies, use `--requisites`.)
|
||||||
|
|
||||||
[references]: ../../glossary.md#gloss-reference
|
[references]: @docroot@/glossary.md#gloss-reference
|
||||||
|
|
||||||
- `--referrers`\
|
- `--referrers`\
|
||||||
Prints the set of *referrers* of the store paths *paths*, that is,
|
Prints the set of *referrers* of the store paths *paths*, that is,
|
||||||
|
@ -90,7 +90,7 @@ symlink.
|
||||||
example when *paths* were substituted from a binary cache.
|
example when *paths* were substituted from a binary cache.
|
||||||
Use `--valid-derivers` instead to obtain valid paths only.
|
Use `--valid-derivers` instead to obtain valid paths only.
|
||||||
|
|
||||||
[deriver]: ../../glossary.md#gloss-deriver
|
[deriver]: @docroot@/glossary.md#gloss-deriver
|
||||||
|
|
||||||
- `--valid-derivers`\
|
- `--valid-derivers`\
|
||||||
Prints a set of derivation files (`.drv`) which are supposed produce
|
Prints a set of derivation files (`.drv`) which are supposed produce
|
||||||
|
|
|
@ -303,7 +303,7 @@ Derivations can declare some infrequently used optional attributes.
|
||||||
[`disallowedReferences`](#adv-attr-disallowedReferences) and [`disallowedRequisites`](#adv-attr-disallowedRequisites),
|
[`disallowedReferences`](#adv-attr-disallowedReferences) and [`disallowedRequisites`](#adv-attr-disallowedRequisites),
|
||||||
the following attributes are available:
|
the following attributes are available:
|
||||||
|
|
||||||
- `maxSize` defines the maximum size of the resulting [store object](../glossary.md#gloss-store-object).
|
- `maxSize` defines the maximum size of the resulting [store object](@docroot@/glossary.md#gloss-store-object).
|
||||||
- `maxClosureSize` defines the maximum size of the output's closure.
|
- `maxClosureSize` defines the maximum size of the output's closure.
|
||||||
- `ignoreSelfRefs` controls whether self-references should be considered when
|
- `ignoreSelfRefs` controls whether self-references should be considered when
|
||||||
checking for allowed references/requisites.
|
checking for allowed references/requisites.
|
||||||
|
|
|
@ -128,8 +128,8 @@ The result is a string.
|
||||||
> The file or directory at *path* must exist and is copied to the [store].
|
> The file or directory at *path* must exist and is copied to the [store].
|
||||||
> The path appears in the result as the corresponding [store path].
|
> The path appears in the result as the corresponding [store path].
|
||||||
|
|
||||||
[store path]: ../glossary.md#gloss-store-path
|
[store path]: @docroot@/glossary.md#gloss-store-path
|
||||||
[store]: ../glossary.md#gloss-store
|
[store]: @docroot@/glossary.md#gloss-store
|
||||||
|
|
||||||
[String and path concatenation]: #string-and-path-concatenation
|
[String and path concatenation]: #string-and-path-concatenation
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@ Rather than writing
|
||||||
|
|
||||||
(where `freetype` is a [derivation]), you can instead write
|
(where `freetype` is a [derivation]), you can instead write
|
||||||
|
|
||||||
[derivation]: ../glossary.md#gloss-derivation
|
[derivation]: @docroot@/glossary.md#gloss-derivation
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
"--with-freetype2-library=${freetype}/lib"
|
"--with-freetype2-library=${freetype}/lib"
|
||||||
|
@ -107,9 +107,9 @@ An expression that is interpolated must evaluate to one of the following:
|
||||||
|
|
||||||
A string interpolates to itself.
|
A string interpolates to itself.
|
||||||
|
|
||||||
A path in an interpolated expression is first copied into the Nix store, and the resulting string is the [store path] of the newly created [store object](../glossary.md#gloss-store-object).
|
A path in an interpolated expression is first copied into the Nix store, and the resulting string is the [store path] of the newly created [store object](@docroot@/glossary.md#gloss-store-object).
|
||||||
|
|
||||||
[store path]: ../glossary.md#gloss-store-path
|
[store path]: @docroot@/glossary.md#gloss-store-path
|
||||||
|
|
||||||
> **Example**
|
> **Example**
|
||||||
>
|
>
|
||||||
|
|
|
@ -113,7 +113,7 @@
|
||||||
For example, assume you used a file path in an interpolated string during a `nix repl` session.
|
For example, assume you used a file path in an interpolated string during a `nix repl` session.
|
||||||
Later in the same session, after having changed the file contents, evaluating the interpolated string with the file path again might not return a new [store path], since Nix might not re-read the file contents.
|
Later in the same session, after having changed the file contents, evaluating the interpolated string with the file path again might not return a new [store path], since Nix might not re-read the file contents.
|
||||||
|
|
||||||
[store path]: ../glossary.md#gloss-store-path
|
[store path]: @docroot@/glossary.md#gloss-store-path
|
||||||
|
|
||||||
Paths can include [string interpolation] and can themselves be [interpolated in other expressions].
|
Paths can include [string interpolation] and can themselves be [interpolated in other expressions].
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@
|
||||||
As the choice of hash formats is no longer binary, the `--base16` flag is also added
|
As the choice of hash formats is no longer binary, the `--base16` flag is also added
|
||||||
to explicitly specify the Base16 format, which is still the default.
|
to explicitly specify the Base16 format, which is still the default.
|
||||||
|
|
||||||
* The special handling of an [installable](../command-ref/new-cli/nix.md#installables) with `.drv` suffix being interpreted as all of the given [store derivation](../glossary.md#gloss-store-derivation)'s output paths is removed, and instead taken as the literal store path that it represents.
|
* The special handling of an [installable](../command-ref/new-cli/nix.md#installables) with `.drv` suffix being interpreted as all of the given [store derivation](@docroot@/glossary.md#gloss-store-derivation)'s output paths is removed, and instead taken as the literal store path that it represents.
|
||||||
|
|
||||||
The new `^` syntax for store paths introduced in Nix 2.13 allows explicitly referencing output paths of a derivation.
|
The new `^` syntax for store paths introduced in Nix 2.13 allows explicitly referencing output paths of a derivation.
|
||||||
Using this is better and more clear than relying on the now-removed `.drv` special handling.
|
Using this is better and more clear than relying on the now-removed `.drv` special handling.
|
||||||
|
|
|
@ -148,7 +148,7 @@ MixOperateOnOptions::MixOperateOnOptions()
|
||||||
{
|
{
|
||||||
addFlag({
|
addFlag({
|
||||||
.longName = "derivation",
|
.longName = "derivation",
|
||||||
.description = "Operate on the [store derivation](../../glossary.md#gloss-store-derivation) rather than its outputs.",
|
.description = "Operate on the [store derivation](@docroot@/glossary.md#gloss-store-derivation) rather than its outputs.",
|
||||||
.category = installablesCategory,
|
.category = installablesCategory,
|
||||||
.handler = {&operateOn, OperateOn::Derivation},
|
.handler = {&operateOn, OperateOn::Derivation},
|
||||||
});
|
});
|
||||||
|
|
|
@ -229,7 +229,7 @@ operate are determined as follows:
|
||||||
Note that a [store derivation] (given by its `.drv` file store path) doesn't have
|
Note that a [store derivation] (given by its `.drv` file store path) doesn't have
|
||||||
any attributes like `meta`, and thus this case doesn't apply to it.
|
any attributes like `meta`, and thus this case doesn't apply to it.
|
||||||
|
|
||||||
[store derivation]: ../../glossary.md#gloss-store-derivation
|
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
|
||||||
|
|
||||||
* Otherwise, Nix will use all outputs of the derivation.
|
* Otherwise, Nix will use all outputs of the derivation.
|
||||||
|
|
||||||
|
|
|
@ -70,7 +70,7 @@ R""(
|
||||||
|
|
||||||
* Print the path of the [store derivation] produced by `nixpkgs#hello`:
|
* Print the path of the [store derivation] produced by `nixpkgs#hello`:
|
||||||
|
|
||||||
[store derivation]: ../../glossary.md#gloss-store-derivation
|
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
|
||||||
|
|
||||||
```console
|
```console
|
||||||
# nix path-info --derivation nixpkgs#hello
|
# nix path-info --derivation nixpkgs#hello
|
||||||
|
|
|
@ -20,7 +20,7 @@ R""(
|
||||||
|
|
||||||
* To copy the log for a specific [store derivation] via SSH:
|
* To copy the log for a specific [store derivation] via SSH:
|
||||||
|
|
||||||
[store derivation]: ../../glossary.md#gloss-store-derivation
|
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
|
||||||
|
|
||||||
```console
|
```console
|
||||||
# nix store copy-log --to ssh-ng://machine /nix/store/ilgm50plpmcgjhcp33z6n4qbnpqfhxym-glibc-2.33-59.drv
|
# nix store copy-log --to ssh-ng://machine /nix/store/ilgm50plpmcgjhcp33z6n4qbnpqfhxym-glibc-2.33-59.drv
|
||||||
|
|
Loading…
Reference in a new issue