From 5789f4b0a989239d967ed0b165b8511bf461ddfb Mon Sep 17 00:00:00 2001 From: Raito Bezarius Date: Tue, 10 Mar 2026 17:38:45 +0100 Subject: [PATCH] manual/rl-next: fine-tune the release notes Follow up of https://gerrit.lix.systems/c/lix/+/5346?tab=comments for the obvious pieces. Change-Id: If0f640f786b0778d016187cb24c0513a48b5a30b Signed-off-by: Raito Bezarius --- doc/manual/rl-next/add-path-references.md | 2 +- doc/manual/rl-next/added-shell-dir-length.md | 2 +- doc/manual/rl-next/deprecated-features.md | 2 +- doc/manual/rl-next/functional-lang-removal.md | 2 +- doc/manual/rl-next/keep-env-derivations-for-nix3.md | 2 +- doc/manual/rl-next/linux-sandbox-launch-overhead.md | 2 +- doc/manual/rl-next/machines-toml.md | 2 +- doc/manual/rl-next/move-nixdaemon-cache-dirs.md | 2 +- doc/manual/rl-next/nix-store-delete-unlink.md | 2 +- doc/manual/rl-next/path-info-missing.md | 2 +- doc/manual/rl-next/remove-xp-fetch-closure-.md | 6 +++--- doc/manual/rl-next/shells-honors-nix-log-fd.md | 4 ++-- 12 files changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/manual/rl-next/add-path-references.md b/doc/manual/rl-next/add-path-references.md index 26aa93b21..6461e00ba 100644 --- a/doc/manual/rl-next/add-path-references.md +++ b/doc/manual/rl-next/add-path-references.md @@ -1,5 +1,5 @@ --- -synopsis: "nix store add-path now supports references" +synopsis: "`nix store add-path` now supports references" cls: [5205] category: "Features" credits: [jade] diff --git a/doc/manual/rl-next/added-shell-dir-length.md b/doc/manual/rl-next/added-shell-dir-length.md index 1de244b70..622df27c3 100644 --- a/doc/manual/rl-next/added-shell-dir-length.md +++ b/doc/manual/rl-next/added-shell-dir-length.md @@ -1,5 +1,5 @@ --- -synopsis: "Nix shells' $NIX_BUILD_TOP are shorter" +synopsis: "Nix shells' `$NIX_BUILD_TOP` are shorter" cls: [4663] issues: [fj#1044] category: "Fixes" diff --git a/doc/manual/rl-next/deprecated-features.md b/doc/manual/rl-next/deprecated-features.md index 0297d5475..ec563ac10 100644 --- a/doc/manual/rl-next/deprecated-features.md +++ b/doc/manual/rl-next/deprecated-features.md @@ -1,5 +1,5 @@ --- -synopsis: 'more deprecated features' +synopsis: 'More deprecated features' issues: [] cls: [2092, 2310, 2311, 4638, 4652, 4764] category: Breaking Changes diff --git a/doc/manual/rl-next/functional-lang-removal.md b/doc/manual/rl-next/functional-lang-removal.md index f81906aaa..9b197f45f 100644 --- a/doc/manual/rl-next/functional-lang-removal.md +++ b/doc/manual/rl-next/functional-lang-removal.md @@ -1,5 +1,5 @@ --- -synopsis: 'functional lang migration' +synopsis: 'Functional lang migration' issues: [lix#856] cls: [3213, 3214, 3215, 3224, 4092, 4093, 4094, 4095, 4096, 4097, 4098, 4099, 4100, 4101, 4102, 4103, 4104, 4105, 4106, 4107, 4108, 4109, 4110, 4111, 4112, 4113, 4114, 4115, 4116, 4117, 4122, 4123, 4269, 4270, 4271, 4272, 4273, 4274, 4347, 4348, 4349, 4350, 4351, 4352, 4569, 4570, 4571, 4572, 4573, 4574, 4596, 4597, 4598, 4599, 4600, 4601, 4602, 4603, 4604, 4605] category: Development diff --git a/doc/manual/rl-next/keep-env-derivations-for-nix3.md b/doc/manual/rl-next/keep-env-derivations-for-nix3.md index a0009cb20..70d02f2a6 100644 --- a/doc/manual/rl-next/keep-env-derivations-for-nix3.md +++ b/doc/manual/rl-next/keep-env-derivations-for-nix3.md @@ -1,5 +1,5 @@ --- -synopsis: "keep-env-derivations is now supported for nix3 CLI (nix profile)" +synopsis: "`keep-env-derivations` is now supported for nix3 CLI (`nix profile`)" cls: [5332] issues: [fj#1095] category: "Features" diff --git a/doc/manual/rl-next/linux-sandbox-launch-overhead.md b/doc/manual/rl-next/linux-sandbox-launch-overhead.md index 9f24d8d93..58d5eefe7 100644 --- a/doc/manual/rl-next/linux-sandbox-launch-overhead.md +++ b/doc/manual/rl-next/linux-sandbox-launch-overhead.md @@ -8,5 +8,5 @@ credits: [horrors] Sandboxed builds are now much cheaper to launch on Linux, with constant management overhead. This will mostly be noticeable when building derivation trees containing many small derivations like nixpkgs' `writeFile` or `runCommand` with scripts that -very quickly. In synthetic tests we have seen build times of 3000 small runCommand +exit quickly. In synthetic tests we have seen build times of 3000 small runCommand drop from 80 seconds to 14 seconds, which is the most optimistic case in practice. diff --git a/doc/manual/rl-next/machines-toml.md b/doc/manual/rl-next/machines-toml.md index 4fb78194e..b301d748b 100644 --- a/doc/manual/rl-next/machines-toml.md +++ b/doc/manual/rl-next/machines-toml.md @@ -7,4 +7,4 @@ credits: [rootile, Qyriad] Lix now supports configuring remote builders using a TOML file instead of the old, very cursed and incomprehensible format. This comes with not only a human-understandable file, but also with better messages and error reports on misconfiguration. -A more detailed Documentation can be found on the [distributed-builds](@docroot@/advanced-topics/distributed-builds.md) Wiki-page +A more detailed Documentation can be found on the [distributed-builds](@docroot@/advanced-topics/distributed-builds.md) documentation page. diff --git a/doc/manual/rl-next/move-nixdaemon-cache-dirs.md b/doc/manual/rl-next/move-nixdaemon-cache-dirs.md index b61eccdd0..367150a17 100644 --- a/doc/manual/rl-next/move-nixdaemon-cache-dirs.md +++ b/doc/manual/rl-next/move-nixdaemon-cache-dirs.md @@ -1,5 +1,5 @@ --- -synopsis: "Move /root/.cache/nix to /var/cache/nix by default" +synopsis: "Move `/root/.cache/nix` to `/var/cache/nix` by default" cls: [4671] issues: [fj#634] category: "Breaking Changes" diff --git a/doc/manual/rl-next/nix-store-delete-unlink.md b/doc/manual/rl-next/nix-store-delete-unlink.md index 76426e93c..61cc33609 100644 --- a/doc/manual/rl-next/nix-store-delete-unlink.md +++ b/doc/manual/rl-next/nix-store-delete-unlink.md @@ -1,5 +1,5 @@ --- -synopsis: nix store delete can now unlink a GC root before deleting its closure +synopsis: "`nix store delete` can now unlink a GC root before deleting its closure" cls: [4660] category: Improvements credits: [Qyriad] diff --git a/doc/manual/rl-next/path-info-missing.md b/doc/manual/rl-next/path-info-missing.md index f31800a07..b7c8106f4 100644 --- a/doc/manual/rl-next/path-info-missing.md +++ b/doc/manual/rl-next/path-info-missing.md @@ -1,5 +1,5 @@ --- -synopsis: "nix path-info no longer lies to the user about fetching paths" +synopsis: "`nix path-info` no longer lies to the user about fetching paths" cls: [4866] issues: [fj#323] category: "Improvements" diff --git a/doc/manual/rl-next/remove-xp-fetch-closure-.md b/doc/manual/rl-next/remove-xp-fetch-closure-.md index 3f42614c2..5756d6144 100644 --- a/doc/manual/rl-next/remove-xp-fetch-closure-.md +++ b/doc/manual/rl-next/remove-xp-fetch-closure-.md @@ -9,7 +9,7 @@ credits: [just1602] The `fetch-closure` experimental feature has been removed. Outside of allowing the user to import closure from binary cache, -`fetchClosure` also allow you to do the following: +`fetchClosure` also allowed you to do the following: * rewrite non-CA path to CA * reject non-CA paths at fetching time @@ -21,7 +21,7 @@ software without paying the evaluation cost of a second nixpkgs. Both use cases are somewhat of an antipattern in Nix semantics. If the user cannot fetch a program directly via the substituter mechanism and fall back to -local build, this is a feature AND a misconfiguration. If the user cannot build +local build, this is a feature *and* a misconfiguration. If the user cannot build certain derivations because they are too expensive, the build directives should pass `-j0` or similar. @@ -33,5 +33,5 @@ or once, and possess stable names. Finally, as for the non-CA → CA features, Lix removed ca-derivations. fetchClosure offers ca-derivations-like features which suffers from similar -shortcomings albeit lessened. It only follows that we should rather deprecate +shortcomings albeit lessened. It only follows that we should deprecate and remove these capabilities. diff --git a/doc/manual/rl-next/shells-honors-nix-log-fd.md b/doc/manual/rl-next/shells-honors-nix-log-fd.md index 3933d9dd0..2914a0252 100644 --- a/doc/manual/rl-next/shells-honors-nix-log-fd.md +++ b/doc/manual/rl-next/shells-honors-nix-log-fd.md @@ -1,12 +1,12 @@ --- -synopsis: "Shells supports $NIX_LOG_FD now" +synopsis: "Shells support `$NIX_LOG_FD` now" cls: [4694, 4695] issues: [fj#336] category: "Improvements" credits: [raito] --- -Lix's "debugging" shells (`nix3-develop` and `nix-shell`) now supports +Lix's "debugging" shells (`nix3-develop` and `nix-shell`) now set the `$NIX_LOG_FD` environment variable. This means that [hook logging in