diff options
author | Jade Lovelace <lix@jade.fyi> | 2024-05-14 19:14:58 -0700 |
---|---|---|
committer | Jade Lovelace <lix@jade.fyi> | 2024-05-15 14:33:35 -0700 |
commit | 272db8af1b905e6cff5859b1ff7e1dd6b2f53f1b (patch) | |
tree | f37acb5d727e01ddad985e3d5afc4ed8479bf7ff /doc/manual | |
parent | 79ee9355ae4a260b941cd185b5789d34d0711ada (diff) |
doc: add release note credits and categories for all the changes in Lix
This does not add missing release notes, and it doesn't do anything
about the profiles feature we would really like to have so we can have
consistent credit.
Change-Id: I72a6f7acfcff85f380be17dac76501a6f4693776
Diffstat (limited to 'doc/manual')
38 files changed, 92 insertions, 4 deletions
diff --git a/doc/manual/rl-next/better-errors-in-nix-repl.md b/doc/manual/rl-next/better-errors-in-nix-repl.md index 14ead8d0c..2f2714a0e 100644 --- a/doc/manual/rl-next/better-errors-in-nix-repl.md +++ b/doc/manual/rl-next/better-errors-in-nix-repl.md @@ -2,6 +2,8 @@ synopsis: Concise error printing in `nix repl` prs: 9928 cls: 811 +category: Improvements +credits: 9999years --- Previously, if an element of a list or attribute set threw an error while diff --git a/doc/manual/rl-next/debugger-locals-for-let-expressions.md b/doc/manual/rl-next/debugger-locals-for-let-expressions.md index 048687631..3f0352327 100644 --- a/doc/manual/rl-next/debugger-locals-for-let-expressions.md +++ b/doc/manual/rl-next/debugger-locals-for-let-expressions.md @@ -2,6 +2,8 @@ synopsis: "`--debugger` can now access bindings from `let` expressions" prs: 9918 issues: 8827 +category: Fixes +credits: 9999years --- Breakpoints and errors in the bindings of a `let` expression can now access diff --git a/doc/manual/rl-next/debugger-on-trace.md b/doc/manual/rl-next/debugger-on-trace.md index 721928550..131d85377 100644 --- a/doc/manual/rl-next/debugger-on-trace.md +++ b/doc/manual/rl-next/debugger-on-trace.md @@ -1,6 +1,8 @@ --- synopsis: Enter the `--debugger` when `builtins.trace` is called if `debugger-on-trace` is set prs: 9914 +category: Features +credits: 9999years --- If the `debugger-on-trace` option is set and `--debugger` is given, diff --git a/doc/manual/rl-next/drop-vendored-toml11.md b/doc/manual/rl-next/drop-vendored-toml11.md index 83bffac31..3e5e44e0d 100644 --- a/doc/manual/rl-next/drop-vendored-toml11.md +++ b/doc/manual/rl-next/drop-vendored-toml11.md @@ -1,6 +1,8 @@ --- synopsis: Stop vendoring toml11 cls: 675 +category: Packaging +credits: winter --- We don't apply any patches to it, and vendoring it locks users into diff --git a/doc/manual/rl-next/drv-string-parse-hang.md b/doc/manual/rl-next/drv-string-parse-hang.md index 1e041d3e9..ab1f17306 100644 --- a/doc/manual/rl-next/drv-string-parse-hang.md +++ b/doc/manual/rl-next/drv-string-parse-hang.md @@ -1,6 +1,8 @@ --- synopsis: Fix handling of truncated `.drv` files. prs: 9673 +category: Fixes +credits: horrors --- Previously a `.drv` that was truncated in the middle of a string would case nix to enter an infinite loop, eventually exhausting all memory and crashing. diff --git a/doc/manual/rl-next/dup-attr-errors.md b/doc/manual/rl-next/dup-attr-errors.md index cce3d9f30..2b8a4fd09 100644 --- a/doc/manual/rl-next/dup-attr-errors.md +++ b/doc/manual/rl-next/dup-attr-errors.md @@ -1,6 +1,8 @@ --- synopsis: Duplicate attribute reports are more accurate cls: 557 +credits: horrors +category: Improvements --- Duplicate attribute errors are now more accurate, showing the path at which an error was detected rather than the full, possibly longer, path that caused the error. diff --git a/doc/manual/rl-next/empty-search-regex.md b/doc/manual/rl-next/empty-search-regex.md index 5f3f293d3..b5e38207a 100644 --- a/doc/manual/rl-next/empty-search-regex.md +++ b/doc/manual/rl-next/empty-search-regex.md @@ -1,6 +1,8 @@ --- synopsis: Disallow empty search regex in `nix search` prs: 9481 +credits: [iFreilicht, horrors] +category: Miscellany --- [`nix search`](@docroot@/command-ref/new-cli/nix3-search.md) now requires a search regex to be passed. To show all packages, use `^`. diff --git a/doc/manual/rl-next/enter-debugger-more-reliably-in-let-and-calls.md b/doc/manual/rl-next/enter-debugger-more-reliably-in-let-and-calls.md index 49e6c1cc8..b94bea3c0 100644 --- a/doc/manual/rl-next/enter-debugger-more-reliably-in-let-and-calls.md +++ b/doc/manual/rl-next/enter-debugger-more-reliably-in-let-and-calls.md @@ -2,6 +2,8 @@ synopsis: The `--debugger` will start more reliably in `let` expressions and function calls prs: 9917 issues: 6649 +credits: [9999years, horrors] +category: Fixes --- Previously, if you attempted to evaluate this file with the debugger: diff --git a/doc/manual/rl-next/env-size-reduction.md b/doc/manual/rl-next/env-size-reduction.md index 40a58bc28..3367e5f91 100644 --- a/doc/manual/rl-next/env-size-reduction.md +++ b/doc/manual/rl-next/env-size-reduction.md @@ -1,6 +1,9 @@ --- synopsis: Reduce eval memory usage and wall time prs: 9658 +cls: 207 +credits: horrors +category: Improvements --- Reduce the size of the `Env` struct used in the evaluator by a pointer, or 8 bytes on most modern machines. diff --git a/doc/manual/rl-next/eval-system.md b/doc/manual/rl-next/eval-system.md index 54456cd6c..d0fd66175 100644 --- a/doc/manual/rl-next/eval-system.md +++ b/doc/manual/rl-next/eval-system.md @@ -1,6 +1,8 @@ --- synopsis: Add new `eval-system` setting prs: 4093 +credits: [matthewbauer, horrors] +category: Features --- Add a new `eval-system` option. diff --git a/doc/manual/rl-next/fchmodat2-sandbox.md b/doc/manual/rl-next/fchmodat2-sandbox.md index 82429a93d..aaa499ccb 100644 --- a/doc/manual/rl-next/fchmodat2-sandbox.md +++ b/doc/manual/rl-next/fchmodat2-sandbox.md @@ -1,6 +1,8 @@ --- synopsis: Creating setuid/setgid binaries with fchmodat2 is now prohibited by the build sandbox prs: 10501 +credits: ma27 +category: Fixes --- The build sandbox blocks any attempt to create setuid/setgid binaries, but didn't check diff --git a/doc/manual/rl-next/fix-nested-follows.md b/doc/manual/rl-next/fix-nested-follows.md index d4a381ba4..5ef655c03 100644 --- a/doc/manual/rl-next/fix-nested-follows.md +++ b/doc/manual/rl-next/fix-nested-follows.md @@ -2,6 +2,9 @@ synopsis: Fix nested flake input `follows` prs: 6621 cls: 994 +credits: [Kha, ma27] +category: Fixes +significance: significant --- Previously nested-input overrides were ignored; that is, the following did not diff --git a/doc/manual/rl-next/forbid-nested-debuggers.md b/doc/manual/rl-next/forbid-nested-debuggers.md index a5924b24f..c96440572 100644 --- a/doc/manual/rl-next/forbid-nested-debuggers.md +++ b/doc/manual/rl-next/forbid-nested-debuggers.md @@ -1,6 +1,8 @@ --- synopsis: Nested debuggers are no longer supported prs: 9920 +credits: 9999years +category: Improvements --- Previously, evaluating an expression that throws an error in the debugger would diff --git a/doc/manual/rl-next/formal-order.md b/doc/manual/rl-next/formal-order.md index 12628e318..7b1922784 100644 --- a/doc/manual/rl-next/formal-order.md +++ b/doc/manual/rl-next/formal-order.md @@ -1,6 +1,8 @@ --- synopsis: consistent order of lambda formals in printed expressions prs: 9874 +credits: horrors +category: Fixes --- Always print lambda formals in lexicographic order rather than the internal, creation-time based symbol order. diff --git a/doc/manual/rl-next/inherit-error-positions.md b/doc/manual/rl-next/inherit-error-positions.md index 643080e9e..b840433fb 100644 --- a/doc/manual/rl-next/inherit-error-positions.md +++ b/doc/manual/rl-next/inherit-error-positions.md @@ -1,6 +1,8 @@ --- synopsis: fix duplicate attribute error positions for `inherit` prs: 9874 +credits: horrors +category: Fixes --- -When an inherit caused a duplicate attribute error the position of the error was not reported correctly, placing the error with the inherit itself or at the start of the bindings block instead of the offending attribute name. +When an inherit caused a duplicate attribute error, the position of the error was not reported correctly, placing the error with the inherit itself or at the start of the bindings block instead of the offending attribute name. diff --git a/doc/manual/rl-next/inherit-from-by-need.md b/doc/manual/rl-next/inherit-from-by-need.md index 67c2cdedf..d198cf314 100644 --- a/doc/manual/rl-next/inherit-from-by-need.md +++ b/doc/manual/rl-next/inherit-from-by-need.md @@ -1,6 +1,8 @@ --- synopsis: "`inherit (x) ...` evaluates `x` only once" prs: 9847 +category: Fixes +credits: horrors --- `inherit (x) a b ...` now evaluates the expression `x` only once for all inherited attributes rather than once for each inherited attribute. diff --git a/doc/manual/rl-next/leading-period.md b/doc/manual/rl-next/leading-period.md index 7a2fd1f67..4b7f6c189 100644 --- a/doc/manual/rl-next/leading-period.md +++ b/doc/manual/rl-next/leading-period.md @@ -2,6 +2,8 @@ synopsis: Store paths are allowed to start with `.` issues: 912 prs: [9867, 9091, 9095, 9120, 9121, 9122, 9130, 9219, 9224] +credits: [roberth, horrors] +category: Fixes --- Leading periods were allowed by accident in Nix 2.4. The Nix team has considered this to be a bug, but this behavior has since been relied on by users, leading to unnecessary difficulties. diff --git a/doc/manual/rl-next/new-assertions.md b/doc/manual/rl-next/new-assertions.md index efaaeb306..15cc2ad88 100644 --- a/doc/manual/rl-next/new-assertions.md +++ b/doc/manual/rl-next/new-assertions.md @@ -1,6 +1,9 @@ --- synopsis: Lix turns more internal bugs into crashes cls: [797, 626] +credits: jade +category: Packaging +significance: significant --- Lix now enables build options such as trapping on signed overflow and enabling diff --git a/doc/manual/rl-next/nix-config-show.md b/doc/manual/rl-next/nix-config-show.md index 1e7545e73..d162f9c3a 100644 --- a/doc/manual/rl-next/nix-config-show.md +++ b/doc/manual/rl-next/nix-config-show.md @@ -2,6 +2,11 @@ synopsis: rename 'nix show-config' to 'nix config show' issues: 7672 prs: 9477 +cls: 993 +credits: [thufschmitt, ma27] +category: Improvements --- `nix show-config` was renamed to `nix config show` to be more consistent with the rest of the command-line interface. + +Running `nix show-config` will now print a deprecation warning saying to use `nix config show` instead. diff --git a/doc/manual/rl-next/nix-env-json-drv-path.md b/doc/manual/rl-next/nix-env-json-drv-path.md index 734cefd1b..c98bd9ee2 100644 --- a/doc/manual/rl-next/nix-env-json-drv-path.md +++ b/doc/manual/rl-next/nix-env-json-drv-path.md @@ -1,6 +1,8 @@ --- synopsis: Fix `nix-env --query --drv-path --json` prs: 9257 +credits: [Artturin, horrors] +category: Fixes --- Fixed a bug where `nix-env --query` ignored `--drv-path` when `--json` was set. diff --git a/doc/manual/rl-next/nix-flake-check-logs-actions.md b/doc/manual/rl-next/nix-flake-check-logs-actions.md index 01ec56a3a..c38826e89 100644 --- a/doc/manual/rl-next/nix-flake-check-logs-actions.md +++ b/doc/manual/rl-next/nix-flake-check-logs-actions.md @@ -2,6 +2,10 @@ synopsis: "`nix flake check` logs the checks" issues: 8882 prs: 8893 +cls: [259, 260, 261, 262] +credits: [9999years, raito, horrors] +category: Improvements +significance: significant --- `nix flake check` now logs the checks it runs and the derivations it evaluates: diff --git a/doc/manual/rl-next/nix-flake-update-ux.md b/doc/manual/rl-next/nix-flake-update-ux.md index 82f00f542..3c17ee32d 100644 --- a/doc/manual/rl-next/nix-flake-update-ux.md +++ b/doc/manual/rl-next/nix-flake-update-ux.md @@ -1,6 +1,8 @@ --- -synopsis: "`Overhaul `nix flake update` and `nix flake lock` UX" +synopsis: "Overhaul `nix flake update` and `nix flake lock` UX" prs: 8817 +credits: [iFreilicht, Lunaphied, thufschmitt] +category: Breaking Changes --- The interface for creating and updating lock files has been overhauled: diff --git a/doc/manual/rl-next/nix-profile-names.md b/doc/manual/rl-next/nix-profile-names.md index 0b2cd35d9..9f87bcf20 100644 --- a/doc/manual/rl-next/nix-profile-names.md +++ b/doc/manual/rl-next/nix-profile-names.md @@ -2,6 +2,8 @@ synopsis: "`nix profile` now allows referring to elements by human-readable name, and no longer accepts indices" prs: 8678 cls: [978, 980] +category: Breaking Changes +credits: [iFreilicht, Qyriad, edolstra] --- [`nix profile`](@docroot@/command-ref/new-cli/nix3-profile.md) now uses names to refer to installed packages when running [`list`](@docroot@/command-ref/new-cli/nix3-profile-list.md), [`remove`](@docroot@/command-ref/new-cli/nix3-profile-remove.md) or [`upgrade`](@docroot@/command-ref/new-cli/nix3-profile-upgrade.md) as opposed to indices. Indices have been removed. Profile element names are generated when a package is installed and remain the same until the package is removed. diff --git a/doc/manual/rl-next/nixversion-fake.md b/doc/manual/rl-next/nixversion-fake.md index 6e42b2bd2..93f75611d 100644 --- a/doc/manual/rl-next/nixversion-fake.md +++ b/doc/manual/rl-next/nixversion-fake.md @@ -1,6 +1,8 @@ --- synopsis: "`builtins.nixVersion` now returns a fixed value \"2.18.3-lix\"" cls: 558 +credits: jade +category: Breaking Changes --- `builtins.nixVersion` now returns a fixed value `"2.18.3-lix"`. This prevents diff --git a/doc/manual/rl-next/no-cache-eval-errors.md b/doc/manual/rl-next/no-cache-eval-errors.md index c80d96dba..b82b571e3 100644 --- a/doc/manual/rl-next/no-cache-eval-errors.md +++ b/doc/manual/rl-next/no-cache-eval-errors.md @@ -1,6 +1,8 @@ --- synopsis: re-evaluate cached evaluation errors cls: 771 +credits: Qyriad +category: Fixes --- "cached failure of [expr]" errors have been removed: expressions already in the diff --git a/doc/manual/rl-next/print-value-in-coercion-error.md b/doc/manual/rl-next/print-value-in-coercion-error.md index cbd6caee6..03ec5b26f 100644 --- a/doc/manual/rl-next/print-value-in-coercion-error.md +++ b/doc/manual/rl-next/print-value-in-coercion-error.md @@ -2,6 +2,8 @@ synopsis: Coercion errors include the failing value issues: 561 prs: 9754 +credits: [9999years, horrors] +category: Improvements --- The `error: cannot coerce a <TYPE> to a string` message now includes the value diff --git a/doc/manual/rl-next/print-value-in-type-error.md b/doc/manual/rl-next/print-value-in-type-error.md index cbd3b7b7f..3d07f156d 100644 --- a/doc/manual/rl-next/print-value-in-type-error.md +++ b/doc/manual/rl-next/print-value-in-type-error.md @@ -2,6 +2,8 @@ synopsis: Type errors include the failing value issues: 561 prs: 9753 +credits: [9999years, horrors] +category: Improvements --- In errors like `value is an integer while a list was expected`, the message now diff --git a/doc/manual/rl-next/reduce-debugger-clutter.md b/doc/manual/rl-next/reduce-debugger-clutter.md index 9bc902eee..c310804fd 100644 --- a/doc/manual/rl-next/reduce-debugger-clutter.md +++ b/doc/manual/rl-next/reduce-debugger-clutter.md @@ -1,6 +1,8 @@ --- synopsis: "Visual clutter in `--debugger` is reduced" prs: 9919 +category: Improvements +credits: [9999years, horrors] --- Before: diff --git a/doc/manual/rl-next/repl-doc-command.md b/doc/manual/rl-next/repl-doc-command.md index 84aaa0802..765e8de50 100644 --- a/doc/manual/rl-next/repl-doc-command.md +++ b/doc/manual/rl-next/repl-doc-command.md @@ -1,6 +1,9 @@ --- synopsis: Experimental REPL support for documentation comments using `:doc` cls: 564 +category: Features +credits: [Lunaphied, jade] +significance: significant --- Using `:doc` in the REPL now supports showing documentation comments when defined on a function. diff --git a/doc/manual/rl-next/repl-overlays.md b/doc/manual/rl-next/repl-overlays.md index 9f48cf381..da69efdca 100644 --- a/doc/manual/rl-next/repl-overlays.md +++ b/doc/manual/rl-next/repl-overlays.md @@ -2,6 +2,9 @@ synopsis: Add `repl-overlays` option prs: 10203 cls: 504 +credits: 9999years +significance: significant +category: Features --- A `repl-overlays` option has been added, which specifies files that can overlay diff --git a/doc/manual/rl-next/short-expr-flag.md b/doc/manual/rl-next/short-expr-flag.md index 5fddd3a25..61ceff24b 100644 --- a/doc/manual/rl-next/short-expr-flag.md +++ b/doc/manual/rl-next/short-expr-flag.md @@ -1,9 +1,11 @@ --- synopsis: reintroduce shortened `-E` form for `--expr` to new CLI cls: 605 +credits: Lunaphied +category: Improvements --- -In the past, it was possible to supply a shorter `-E` flag instead of fully +In the old CLI, it was possible to supply a shorter `-E` flag instead of fully specifying `--expr` every time you wished to provide an expression that would be evaluated to produce the given command's input. This was retained for the `--file` flag when the new CLI utilities were written with `-f`, but `-E` was diff --git a/doc/manual/rl-next/source-location-in-while-evaluating-attribute.md b/doc/manual/rl-next/source-location-in-while-evaluating-attribute.md index 0e0b74c5a..b72241862 100644 --- a/doc/manual/rl-next/source-location-in-while-evaluating-attribute.md +++ b/doc/manual/rl-next/source-location-in-while-evaluating-attribute.md @@ -1,6 +1,8 @@ --- synopsis: "In the debugger, `while evaluating the attribute` errors now include position information" prs: 9915 +credits: 9999years +category: Fixes --- Before: diff --git a/doc/manual/rl-next/source-positions-in-errors.md b/doc/manual/rl-next/source-positions-in-errors.md index 1556f8b64..a9de87f28 100644 --- a/doc/manual/rl-next/source-positions-in-errors.md +++ b/doc/manual/rl-next/source-positions-in-errors.md @@ -2,6 +2,8 @@ synopsis: Source locations are printed more consistently in errors issues: 561 prs: 9555 +credits: [9999years, horrors] +category: Improvements --- Source location information is now included in error messages more diff --git a/doc/manual/rl-next/stack-overflow-segfaults.md b/doc/manual/rl-next/stack-overflow-segfaults.md index 3d9753248..24d62ea1e 100644 --- a/doc/manual/rl-next/stack-overflow-segfaults.md +++ b/doc/manual/rl-next/stack-overflow-segfaults.md @@ -2,6 +2,9 @@ synopsis: Some stack overflow segfaults are fixed issues: 9616 prs: 9617 +cls: 205 +category: Improvements +credits: [9999years, horrors] --- The number of nested function calls has been restricted, to detect and report diff --git a/doc/manual/rl-next/upgrade-nix-override.md b/doc/manual/rl-next/upgrade-nix-override.md index d3046ff13..819f7e7f8 100644 --- a/doc/manual/rl-next/upgrade-nix-override.md +++ b/doc/manual/rl-next/upgrade-nix-override.md @@ -1,6 +1,8 @@ --- -synopsis: add --store-path argument to `nix upgrade-nix`, to manually specify the Nix to upgrade to +synopsis: add `--store-path` argument to `nix upgrade-nix`, to manually specify the Nix to upgrade to cls: 953 +credits: Qyriad +category: Features --- `nix upgrade-nix` by default downloads a manifest to find the new Nix version to upgrade to, but now you can specify `--store-path` to upgrade Nix to an arbitrary version from the Nix store. diff --git a/doc/manual/rl-next/upgrade-nix-profile-compat.md b/doc/manual/rl-next/upgrade-nix-profile-compat.md index df9879c6f..012d0e7e5 100644 --- a/doc/manual/rl-next/upgrade-nix-profile-compat.md +++ b/doc/manual/rl-next/upgrade-nix-profile-compat.md @@ -1,6 +1,8 @@ --- synopsis: using `nix profile` on `/nix/var/nix/profiles/default` no longer breaks `nix upgrade-nix` cls: 952 +credits: Qyriad +category: Fixes --- On non-NixOS, Nix is conventionally installed into a `nix-env` style profile at /nix/var/nix/profiles/default. diff --git a/doc/manual/rl-next/upstart-removal.md b/doc/manual/rl-next/upstart-removal.md index b1b7ad176..5166d6b15 100644 --- a/doc/manual/rl-next/upstart-removal.md +++ b/doc/manual/rl-next/upstart-removal.md @@ -1,6 +1,8 @@ --- synopsis: Upstart scripts removed cls: 574 +category: Packaging +credits: jade --- Upstart scripts have been removed from Lix, since Upstart is obsolete and has diff --git a/doc/manual/rl-next/with-error-reporting.md b/doc/manual/rl-next/with-error-reporting.md index f6c4a36fe..8258fd51b 100644 --- a/doc/manual/rl-next/with-error-reporting.md +++ b/doc/manual/rl-next/with-error-reporting.md @@ -1,6 +1,9 @@ --- synopsis: Better error reporting for `with` expressions prs: 9658 +cls: 207 +credits: horrors +category: Improvements --- `with` expressions using non-attrset values to resolve variables are now reported with proper positions. |