From 1d6a2c28a49865a1b81199eb44c06e70668297ea Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Mon, 9 Dec 2024 16:21:12 +0100 Subject: [PATCH] lib.types: add release notes --- nixos/doc/manual/redirects.json | 6 ++++++ nixos/doc/manual/release-notes/rl-2505.section.md | 8 ++++++++ 2 files changed, 14 insertions(+) diff --git a/nixos/doc/manual/redirects.json b/nixos/doc/manual/redirects.json index 5f7bf93db21ed..6f897ce7a9917 100644 --- a/nixos/doc/manual/redirects.json +++ b/nixos/doc/manual/redirects.json @@ -1844,6 +1844,12 @@ "sec-release-25.05-notable-changes": [ "release-notes.html#sec-release-25.05-notable-changes" ], + "sec-release-25.05-lib": [ + "release-notes.html#sec-release-25.05-lib" + ], + "sec-release-25.05-lib-breaking": [ + "release-notes.html#sec-release-25.05-lib-breaking" + ], "sec-release-24.11": [ "release-notes.html#sec-release-24.11" ], diff --git a/nixos/doc/manual/release-notes/rl-2505.section.md b/nixos/doc/manual/release-notes/rl-2505.section.md index f173d0d93b1d3..f3a58367e055f 100644 --- a/nixos/doc/manual/release-notes/rl-2505.section.md +++ b/nixos/doc/manual/release-notes/rl-2505.section.md @@ -118,3 +118,11 @@ - `bind.cacheNetworks` now only controls access for recursive queries, where it previously controlled access for all queries. + +## Nixpkgs Library {#sec-release-25.05-lib} + +### Breaking changes {#sec-release-25.05-lib-breaking} + +- Structure of the `functor` of some types has changed. `functor` is an implementation detail and should not be relied upon. If you did rely on it let us know in this [PR](https://github.com/NixOS/nixpkgs/pull/363565). + - [`lib.types.enum`](https://nixos.org/manual/nixos/unstable/#sec-option-types-basic): Previously the `functor.payload` was the list of enum values directly. Now it is an attribute set containing the values in the `values` attribute. + - [`lib.types.separatedString`](https://nixos.org/manual/nixos/unstable/#sec-option-types-string): Previously the `functor.payload` was the seperator directly. Now it is an attribute set containing the seperator in the `sep` attribute.