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
This commit is contained in:
jade 2024-05-14 19:14:58 -07:00
parent 79ee9355ae
commit 272db8af1b
38 changed files with 92 additions and 4 deletions

View file

@ -2,6 +2,8 @@
synopsis: Concise error printing in `nix repl` synopsis: Concise error printing in `nix repl`
prs: 9928 prs: 9928
cls: 811 cls: 811
category: Improvements
credits: 9999years
--- ---
Previously, if an element of a list or attribute set threw an error while Previously, if an element of a list or attribute set threw an error while

View file

@ -2,6 +2,8 @@
synopsis: "`--debugger` can now access bindings from `let` expressions" synopsis: "`--debugger` can now access bindings from `let` expressions"
prs: 9918 prs: 9918
issues: 8827 issues: 8827
category: Fixes
credits: 9999years
--- ---
Breakpoints and errors in the bindings of a `let` expression can now access Breakpoints and errors in the bindings of a `let` expression can now access

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Enter the `--debugger` when `builtins.trace` is called if `debugger-on-trace` is set synopsis: Enter the `--debugger` when `builtins.trace` is called if `debugger-on-trace` is set
prs: 9914 prs: 9914
category: Features
credits: 9999years
--- ---
If the `debugger-on-trace` option is set and `--debugger` is given, If the `debugger-on-trace` option is set and `--debugger` is given,

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Stop vendoring toml11 synopsis: Stop vendoring toml11
cls: 675 cls: 675
category: Packaging
credits: winter
--- ---
We don't apply any patches to it, and vendoring it locks users into We don't apply any patches to it, and vendoring it locks users into

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Fix handling of truncated `.drv` files. synopsis: Fix handling of truncated `.drv` files.
prs: 9673 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. 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.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Duplicate attribute reports are more accurate synopsis: Duplicate attribute reports are more accurate
cls: 557 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. 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.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Disallow empty search regex in `nix search` synopsis: Disallow empty search regex in `nix search`
prs: 9481 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 `^`. [`nix search`](@docroot@/command-ref/new-cli/nix3-search.md) now requires a search regex to be passed. To show all packages, use `^`.

View file

@ -2,6 +2,8 @@
synopsis: The `--debugger` will start more reliably in `let` expressions and function calls synopsis: The `--debugger` will start more reliably in `let` expressions and function calls
prs: 9917 prs: 9917
issues: 6649 issues: 6649
credits: [9999years, horrors]
category: Fixes
--- ---
Previously, if you attempted to evaluate this file with the debugger: Previously, if you attempted to evaluate this file with the debugger:

View file

@ -1,6 +1,9 @@
--- ---
synopsis: Reduce eval memory usage and wall time synopsis: Reduce eval memory usage and wall time
prs: 9658 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. Reduce the size of the `Env` struct used in the evaluator by a pointer, or 8 bytes on most modern machines.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Add new `eval-system` setting synopsis: Add new `eval-system` setting
prs: 4093 prs: 4093
credits: [matthewbauer, horrors]
category: Features
--- ---
Add a new `eval-system` option. Add a new `eval-system` option.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Creating setuid/setgid binaries with fchmodat2 is now prohibited by the build sandbox synopsis: Creating setuid/setgid binaries with fchmodat2 is now prohibited by the build sandbox
prs: 10501 prs: 10501
credits: ma27
category: Fixes
--- ---
The build sandbox blocks any attempt to create setuid/setgid binaries, but didn't check The build sandbox blocks any attempt to create setuid/setgid binaries, but didn't check

View file

@ -2,6 +2,9 @@
synopsis: Fix nested flake input `follows` synopsis: Fix nested flake input `follows`
prs: 6621 prs: 6621
cls: 994 cls: 994
credits: [Kha, ma27]
category: Fixes
significance: significant
--- ---
Previously nested-input overrides were ignored; that is, the following did not Previously nested-input overrides were ignored; that is, the following did not

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Nested debuggers are no longer supported synopsis: Nested debuggers are no longer supported
prs: 9920 prs: 9920
credits: 9999years
category: Improvements
--- ---
Previously, evaluating an expression that throws an error in the debugger would Previously, evaluating an expression that throws an error in the debugger would

View file

@ -1,6 +1,8 @@
--- ---
synopsis: consistent order of lambda formals in printed expressions synopsis: consistent order of lambda formals in printed expressions
prs: 9874 prs: 9874
credits: horrors
category: Fixes
--- ---
Always print lambda formals in lexicographic order rather than the internal, creation-time based symbol order. Always print lambda formals in lexicographic order rather than the internal, creation-time based symbol order.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: fix duplicate attribute error positions for `inherit` synopsis: fix duplicate attribute error positions for `inherit`
prs: 9874 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.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: "`inherit (x) ...` evaluates `x` only once" synopsis: "`inherit (x) ...` evaluates `x` only once"
prs: 9847 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. `inherit (x) a b ...` now evaluates the expression `x` only once for all inherited attributes rather than once for each inherited attribute.

View file

@ -2,6 +2,8 @@
synopsis: Store paths are allowed to start with `.` synopsis: Store paths are allowed to start with `.`
issues: 912 issues: 912
prs: [9867, 9091, 9095, 9120, 9121, 9122, 9130, 9219, 9224] 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. 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.

View file

@ -1,6 +1,9 @@
--- ---
synopsis: Lix turns more internal bugs into crashes synopsis: Lix turns more internal bugs into crashes
cls: [797, 626] cls: [797, 626]
credits: jade
category: Packaging
significance: significant
--- ---
Lix now enables build options such as trapping on signed overflow and enabling Lix now enables build options such as trapping on signed overflow and enabling

View file

@ -2,6 +2,11 @@
synopsis: rename 'nix show-config' to 'nix config show' synopsis: rename 'nix show-config' to 'nix config show'
issues: 7672 issues: 7672
prs: 9477 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. `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.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Fix `nix-env --query --drv-path --json` synopsis: Fix `nix-env --query --drv-path --json`
prs: 9257 prs: 9257
credits: [Artturin, horrors]
category: Fixes
--- ---
Fixed a bug where `nix-env --query` ignored `--drv-path` when `--json` was set. Fixed a bug where `nix-env --query` ignored `--drv-path` when `--json` was set.

View file

@ -2,6 +2,10 @@
synopsis: "`nix flake check` logs the checks" synopsis: "`nix flake check` logs the checks"
issues: 8882 issues: 8882
prs: 8893 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: `nix flake check` now logs the checks it runs and the derivations it evaluates:

View file

@ -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 prs: 8817
credits: [iFreilicht, Lunaphied, thufschmitt]
category: Breaking Changes
--- ---
The interface for creating and updating lock files has been overhauled: The interface for creating and updating lock files has been overhauled:

View file

@ -2,6 +2,8 @@
synopsis: "`nix profile` now allows referring to elements by human-readable name, and no longer accepts indices" synopsis: "`nix profile` now allows referring to elements by human-readable name, and no longer accepts indices"
prs: 8678 prs: 8678
cls: [978, 980] 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. [`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.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: "`builtins.nixVersion` now returns a fixed value \"2.18.3-lix\"" synopsis: "`builtins.nixVersion` now returns a fixed value \"2.18.3-lix\""
cls: 558 cls: 558
credits: jade
category: Breaking Changes
--- ---
`builtins.nixVersion` now returns a fixed value `"2.18.3-lix"`. This prevents `builtins.nixVersion` now returns a fixed value `"2.18.3-lix"`. This prevents

View file

@ -1,6 +1,8 @@
--- ---
synopsis: re-evaluate cached evaluation errors synopsis: re-evaluate cached evaluation errors
cls: 771 cls: 771
credits: Qyriad
category: Fixes
--- ---
"cached failure of [expr]" errors have been removed: expressions already in the "cached failure of [expr]" errors have been removed: expressions already in the

View file

@ -2,6 +2,8 @@
synopsis: Coercion errors include the failing value synopsis: Coercion errors include the failing value
issues: 561 issues: 561
prs: 9754 prs: 9754
credits: [9999years, horrors]
category: Improvements
--- ---
The `error: cannot coerce a <TYPE> to a string` message now includes the value The `error: cannot coerce a <TYPE> to a string` message now includes the value

View file

@ -2,6 +2,8 @@
synopsis: Type errors include the failing value synopsis: Type errors include the failing value
issues: 561 issues: 561
prs: 9753 prs: 9753
credits: [9999years, horrors]
category: Improvements
--- ---
In errors like `value is an integer while a list was expected`, the message now In errors like `value is an integer while a list was expected`, the message now

View file

@ -1,6 +1,8 @@
--- ---
synopsis: "Visual clutter in `--debugger` is reduced" synopsis: "Visual clutter in `--debugger` is reduced"
prs: 9919 prs: 9919
category: Improvements
credits: [9999years, horrors]
--- ---
Before: Before:

View file

@ -1,6 +1,9 @@
--- ---
synopsis: Experimental REPL support for documentation comments using `:doc` synopsis: Experimental REPL support for documentation comments using `:doc`
cls: 564 cls: 564
category: Features
credits: [Lunaphied, jade]
significance: significant
--- ---
Using `:doc` in the REPL now supports showing documentation comments when defined on a function. Using `:doc` in the REPL now supports showing documentation comments when defined on a function.

View file

@ -2,6 +2,9 @@
synopsis: Add `repl-overlays` option synopsis: Add `repl-overlays` option
prs: 10203 prs: 10203
cls: 504 cls: 504
credits: 9999years
significance: significant
category: Features
--- ---
A `repl-overlays` option has been added, which specifies files that can overlay A `repl-overlays` option has been added, which specifies files that can overlay

View file

@ -1,9 +1,11 @@
--- ---
synopsis: reintroduce shortened `-E` form for `--expr` to new CLI synopsis: reintroduce shortened `-E` form for `--expr` to new CLI
cls: 605 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 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 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 `--file` flag when the new CLI utilities were written with `-f`, but `-E` was

View file

@ -1,6 +1,8 @@
--- ---
synopsis: "In the debugger, `while evaluating the attribute` errors now include position information" synopsis: "In the debugger, `while evaluating the attribute` errors now include position information"
prs: 9915 prs: 9915
credits: 9999years
category: Fixes
--- ---
Before: Before:

View file

@ -2,6 +2,8 @@
synopsis: Source locations are printed more consistently in errors synopsis: Source locations are printed more consistently in errors
issues: 561 issues: 561
prs: 9555 prs: 9555
credits: [9999years, horrors]
category: Improvements
--- ---
Source location information is now included in error messages more Source location information is now included in error messages more

View file

@ -2,6 +2,9 @@
synopsis: Some stack overflow segfaults are fixed synopsis: Some stack overflow segfaults are fixed
issues: 9616 issues: 9616
prs: 9617 prs: 9617
cls: 205
category: Improvements
credits: [9999years, horrors]
--- ---
The number of nested function calls has been restricted, to detect and report The number of nested function calls has been restricted, to detect and report

View file

@ -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 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. `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.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: using `nix profile` on `/nix/var/nix/profiles/default` no longer breaks `nix upgrade-nix` synopsis: using `nix profile` on `/nix/var/nix/profiles/default` no longer breaks `nix upgrade-nix`
cls: 952 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. On non-NixOS, Nix is conventionally installed into a `nix-env` style profile at /nix/var/nix/profiles/default.

View file

@ -1,6 +1,8 @@
--- ---
synopsis: Upstart scripts removed synopsis: Upstart scripts removed
cls: 574 cls: 574
category: Packaging
credits: jade
--- ---
Upstart scripts have been removed from Lix, since Upstart is obsolete and has Upstart scripts have been removed from Lix, since Upstart is obsolete and has

View file

@ -1,6 +1,9 @@
--- ---
synopsis: Better error reporting for `with` expressions synopsis: Better error reporting for `with` expressions
prs: 9658 prs: 9658
cls: 207
credits: horrors
category: Improvements
--- ---
`with` expressions using non-attrset values to resolve variables are now reported with proper positions. `with` expressions using non-attrset values to resolve variables are now reported with proper positions.