aboutsummaryrefslogtreecommitdiff
path: root/doc/manual
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2022-12-06 11:31:34 +0100
committerGitHub <noreply@github.com>2022-12-06 11:31:34 +0100
commit54906bc93c0db36b03ac76b67594403261ffd377 (patch)
tree96c4b72274d5f89f264ea29be8b082d6cb8f75d7 /doc/manual
parentbfcf30f0abdfd1df4364919f203d04ff08d7314c (diff)
parent484578d3f9b15c34c0e3a42cc0d1f87f1c15d7f6 (diff)
Merge pull request #7382 from fricklerhandwerk/doc-automatic-uid
move documentation on `auto-allocate-uids` to options docs
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/src/release-notes/rl-next.md42
1 files changed, 18 insertions, 24 deletions
diff --git a/doc/manual/src/release-notes/rl-next.md b/doc/manual/src/release-notes/rl-next.md
index 8b314b5f6..bf51aa1f7 100644
--- a/doc/manual/src/release-notes/rl-next.md
+++ b/doc/manual/src/release-notes/rl-next.md
@@ -12,43 +12,37 @@
([#7260](https://github.com/NixOS/nix/pull/7260)).
* Nix can now automatically pick UIDs for builds, removing the need to
- create `nixbld*` user accounts. These UIDs are allocated starting at
- 872415232 (0x34000000) on Linux and 56930 on macOS.
+ create `nixbld*` user accounts.
- This is an experimental feature. To enable it, add the following to
- `nix.conf`:
+ See [`auto-allocate-uids`].
- ```
- extra-experimental-features = auto-allocate-uids
- auto-allocate-uids = true
- ```
+ [`auto-allocate-uids`]: (../command-ref/conf-file.md#conf-auto-allocate-uids)
* On Linux, Nix can now run builds in a user namespace where the build
- runs as root (UID 0) and has 65,536 UIDs available. This is
- primarily useful for running containers such as `systemd-nspawn`
- inside a Nix build. For an example, see
- https://github.com/NixOS/nix/blob/67bcb99700a0da1395fa063d7c6586740b304598/tests/systemd-nspawn.nix.
+ runs as root (UID 0) and has 65,536 UIDs available.
+
+ <!-- FIXME: move this to its own section about system features -->
+
+ This is primarily useful for running containers such as `systemd-nspawn`
+ inside a Nix build. For an example, see [`tests/systemd-nspawn/nix`][nspawn].
+
+ [nspawn]: https://github.com/NixOS/nix/blob/67bcb99700a0da1395fa063d7c6586740b304598/tests/systemd-nspawn.nix.
- A build can enable this by requiring the `uid-range` system feature,
- i.e. by setting the derivation attribute
+ A build can enable this by by setting the derivation attribute:
```
requiredSystemFeatures = [ "uid-range" ];
```
- The `uid-range` system feature requires the `auto-allocate-uids`
- setting to be enabled (see above).
+ The `uid-range` [system feature] requires the [`auto-allocate-uids`]
+ setting to be enabled.
-* On Linux, Nix has experimental support for running builds inside a
- cgroup. It can be enabled by adding
+ [system feature]: (../command-ref/conf-file.md#conf-system-features),
- ```
- extra-experimental-features = cgroups
- use-cgroups = true
- ```
+* On Linux, Nix has experimental support for running builds inside a
+ cgroup.
- to `nix.conf`. Cgroups are required for derivations that require the
- `uid-range` system feature.
+ See [`use-cgroups`](../command-ref/conf-file.md#conf-use-cgroups).
* `nix build --json` now prints some statistics about top-level
derivations, such as CPU statistics when cgroups are enabled.