From f659a1e63803926c002d6a899728ce985b3c1846 Mon Sep 17 00:00:00 2001 From: helle Date: Thu, 1 May 2025 13:21:40 +0200 Subject: [PATCH] Fix various links to anchors in documentation. These are updates to several links in the documentation that are not currently pointing to existing anchors in the documentation, these were found using the unfinished version of the mdbook-linkchecker we are working on. Fixes include pointing them to the correct anchor, inserting anchors (in updated html5 style, though debatable) and in the case of the historical release notes, removing them, fixing #809. Change-Id: If4ef89dc89506aa131a764312d97a86179ccd6f5 --- doc/manual/src/command-ref/nix-channel.md | 2 +- doc/manual/src/command-ref/nix-env/upgrade.md | 2 +- doc/manual/src/contributing/hacking.md | 4 ++-- doc/manual/src/glossary.md | 2 +- doc/manual/src/language/values.md | 2 +- doc/manual/src/release-notes/rl-2.18.md | 2 +- lix/libutil/experimental-features/auto-allocate-uids.md | 2 +- lix/libutil/experimental-features/cgroups.md | 2 +- lix/nix/nix.md | 2 +- lix/nix/shell.md | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/manual/src/command-ref/nix-channel.md b/doc/manual/src/command-ref/nix-channel.md index cebbc7b00..8111238c9 100644 --- a/doc/manual/src/command-ref/nix-channel.md +++ b/doc/manual/src/command-ref/nix-channel.md @@ -14,7 +14,7 @@ The moving parts of channels are: - The official channels listed at - The user-specific list of [subscribed channels](#subscribed-channels) - The [downloaded channel contents](#channels) -- The [Nix expression search path](@docroot@/command-ref/conf-file.md#conf-nix-path), set with the [`-I` option](#opt-i) or the [`NIX_PATH` environment variable](#env-NIX_PATH) +- The [Nix expression search path](@docroot@/command-ref/conf-file.md#conf-nix-path), set with the [`-I` option](#opt-I) or the [`NIX_PATH` environment variable](#env-NIX_PATH) > **Note** > diff --git a/doc/manual/src/command-ref/nix-env/upgrade.md b/doc/manual/src/command-ref/nix-env/upgrade.md index 11e0eddbe..a658f3d3a 100644 --- a/doc/manual/src/command-ref/nix-env/upgrade.md +++ b/doc/manual/src/command-ref/nix-env/upgrade.md @@ -22,7 +22,7 @@ left untouched; this is not an error. It is also not an error if an element of *args* matches no installed derivations. For a description of how *args* is mapped to a set of store paths, see -[`--install`](#operation---install). If *args* describes multiple +[`--install`](install.md). If *args* describes multiple store paths with the same symbolic name, only the one with the highest version is installed. diff --git a/doc/manual/src/contributing/hacking.md b/doc/manual/src/contributing/hacking.md index 834ae6361..301455081 100644 --- a/doc/manual/src/contributing/hacking.md +++ b/doc/manual/src/contributing/hacking.md @@ -256,13 +256,13 @@ To build with one of those environments, you can use $ nix build .#nix-ccacheStdenv ``` -for flake-enabled Nix, or +for flake-enabled Nix, or ```console $ nix-build --attr nix-ccacheStdenv ``` -for classic Nix. +for classic Nix. You can use any of the other supported environments in place of `nix-ccacheStdenv`. diff --git a/doc/manual/src/glossary.md b/doc/manual/src/glossary.md index 07ba27587..8aafa1c7e 100644 --- a/doc/manual/src/glossary.md +++ b/doc/manual/src/glossary.md @@ -101,7 +101,7 @@ See [File System Object](@docroot@/architecture/file-system-object.md) for details. - [file system object]: #gloss-file-system-object + [file system object]: #gloss-store-path - [store object]{#gloss-store-object} diff --git a/doc/manual/src/language/values.md b/doc/manual/src/language/values.md index 30d2169ca..ae4e9bd14 100644 --- a/doc/manual/src/language/values.md +++ b/doc/manual/src/language/values.md @@ -164,7 +164,7 @@ Note that lists are only lazy in values, and they are strict in length. An attribute set is a collection of name-value-pairs (called *attributes*) enclosed in curly brackets (`{ }`). -An attribute name can be an identifier or a [string](#string). +An attribute name can be an identifier or a [string](#type-string). An identifier must start with a letter (`a-z`, `A-Z`) or underscore (`_`), and can otherwise contain letters (`a-z`, `A-Z`), numbers (`0-9`), underscores (`_`), apostrophes (`'`), or dashes (`-`). > *name* = *identifier* | *string* \ diff --git a/doc/manual/src/release-notes/rl-2.18.md b/doc/manual/src/release-notes/rl-2.18.md index 4bbc52b50..bcfe8d878 100644 --- a/doc/manual/src/release-notes/rl-2.18.md +++ b/doc/manual/src/release-notes/rl-2.18.md @@ -13,7 +13,7 @@ - The `discard-references` feature has been stabilized. This means that the - [unsafeDiscardReferences](@docroot@/contributing/experimental-features.md#xp-feature-discard-references) + `unsafeDiscardReferences` attribute is no longer guarded by an experimental flag and can be used freely. diff --git a/lix/libutil/experimental-features/auto-allocate-uids.md b/lix/libutil/experimental-features/auto-allocate-uids.md index af7a2b68d..82e380ed3 100644 --- a/lix/libutil/experimental-features/auto-allocate-uids.md +++ b/lix/libutil/experimental-features/auto-allocate-uids.md @@ -3,4 +3,4 @@ name: auto-allocate-uids internalName: AutoAllocateUids --- Allows Nix to automatically pick UIDs for builds, rather than creating -`nixbld*` user accounts. See the [`auto-allocate-uids`](#conf-auto-allocate-uids) setting for details. +`nixbld*` user accounts. See the [`auto-allocate-uids`](../command-ref/conf-file.md#conf-auto-allocate-uids) setting for details. diff --git a/lix/libutil/experimental-features/cgroups.md b/lix/libutil/experimental-features/cgroups.md index 66e64fde9..2a00b7c8c 100644 --- a/lix/libutil/experimental-features/cgroups.md +++ b/lix/libutil/experimental-features/cgroups.md @@ -3,4 +3,4 @@ name: cgroups internalName: Cgroups --- Allows Nix to execute builds inside cgroups. See -the [`use-cgroups`](#conf-use-cgroups) setting for details. +the [`use-cgroups`](../command-ref/conf-file.md#conf-use-cgroups) setting for details. diff --git a/lix/nix/nix.md b/lix/nix/nix.md index dbf070fc3..d11639253 100644 --- a/lix/nix/nix.md +++ b/lix/nix/nix.md @@ -209,7 +209,7 @@ For example, you could build from a specific version of Nixpkgs with something l $ nix build -f "https://github.com/NixOS/nixpkgs/archive/refs/heads/release-24.11.tar.gz" firefox ``` -If a *fileish* starts with `flake:`, the rest of the argument is interpreted as a [flakeref](./nix3-flake.md#flake-reference) (see `nix flake --help` or `man nix3-flake`), which requires the "flakes" experimental feature to be enabled. +If a *fileish* starts with `flake:`, the rest of the argument is interpreted as a [flakeref](./nix3-flake.md#flake-references) (see `nix flake --help` or `man nix3-flake`), which requires the "flakes" experimental feature to be enabled. This is is *not quite* the same as specifying a [flake output attrpath](#flake-output-attribute). It does *not* access the flake directly and does not even consider the existence of flake.nix, but instead fetches it as if it is not a flake at all and `import`s the unpacked directory. In other words, it assumes that the flake has a `default.nix` file, and then interprets the attribute path relative to what `default.nix` evaluates to. diff --git a/lix/nix/shell.md b/lix/nix/shell.md index 598a39854..e1b27de7a 100644 --- a/lix/nix/shell.md +++ b/lix/nix/shell.md @@ -50,7 +50,7 @@ R""( # Description `nix shell` runs a command in an environment in which the `$PATH` variable -provides the specified [*installables*](./nix.md#installable). If no command is specified, it starts the +provides the specified [*installables*](./nix.md#installables). If no command is specified, it starts the default shell of your user account specified by `$SHELL`. )""