From 682a28a76bf15ba527c3f4d06a84d33070784fa4 Mon Sep 17 00:00:00 2001 From: John Ericson Date: Wed, 2 Apr 2025 15:20:47 -0400 Subject: [PATCH 1/5] release notes: 2.28.0 (cherry picked from commit 703f0fbe74bbc54532d19895bb32932b6fd77eb4) --- doc/manual/rl-next/c-api-flake-init.md | 20 ----- doc/manual/source/SUMMARY.md.in | 1 + doc/manual/source/release-notes/rl-2.28.md | 91 ++++++++++++++++++++++ 3 files changed, 92 insertions(+), 20 deletions(-) delete mode 100644 doc/manual/rl-next/c-api-flake-init.md create mode 100644 doc/manual/source/release-notes/rl-2.28.md diff --git a/doc/manual/rl-next/c-api-flake-init.md b/doc/manual/rl-next/c-api-flake-init.md deleted file mode 100644 index d6e7c3890..000000000 --- a/doc/manual/rl-next/c-api-flake-init.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -synopsis: C API `nix_flake_init_global` removed -prs: 12759 -issues: 5638 ---- - -In order to improve the modularity of the code base, we are removing a use of global state, and therefore the `nix_flake_init_global` function. - -Instead, use `nix_flake_settings_add_to_eval_state_builder`. For example: - -```diff -- nix_flake_init_global(ctx, settings); -- HANDLE_ERROR(ctx); -- - nix_eval_state_builder * builder = nix_eval_state_builder_new(ctx, store); - HANDLE_ERROR(ctx); - -+ nix_flake_settings_add_to_eval_state_builder(ctx, settings, builder); -+ HANDLE_ERROR(ctx); -``` diff --git a/doc/manual/source/SUMMARY.md.in b/doc/manual/source/SUMMARY.md.in index 3e7e961cb..5932e0999 100644 --- a/doc/manual/source/SUMMARY.md.in +++ b/doc/manual/source/SUMMARY.md.in @@ -135,6 +135,7 @@ - [Contributing](development/contributing.md) - [Releases](release-notes/index.md) {{#include ./SUMMARY-rl-next.md}} + - [Release 2.28 (2025-04-02)](release-notes/rl-2.28.md) - [Release 2.27 (2025-03-03)](release-notes/rl-2.27.md) - [Release 2.26 (2025-01-22)](release-notes/rl-2.26.md) - [Release 2.25 (2024-11-07)](release-notes/rl-2.25.md) diff --git a/doc/manual/source/release-notes/rl-2.28.md b/doc/manual/source/release-notes/rl-2.28.md new file mode 100644 index 000000000..701b40590 --- /dev/null +++ b/doc/manual/source/release-notes/rl-2.28.md @@ -0,0 +1,91 @@ +# Release 2.28.0 (2025-04-02) + +This is an atypical release -- instead of being branched off from `master`, it is branched off from the 2.27.x maintenance branch. +The purpose of this is to satisfy both these goals: + +- Release with number of API-breaking changes that are not suitable to backport to 2.27 + +- Do not Release with arbitrary new commits from master + +The reason for the combinations of these goals is that we would like this version of Nix to the default in Nixpkgs 25.05, yet, we are getting close to the Nixpkgs 25.05 version freeze. +These API changes complete the big infrastructure rework that accompanies the switch to Meson --- we want to batch all these changes together so there is one round of breakage. +But we don't want to to release with arbitrary new changes form master, so close to a major release, before those changes have had time to "incubate". + +## Major changes + +- Unstable C++ API reworked + [#12836](https://github.com/NixOS/nix/pull/12836) + [#12798](https://github.com/NixOS/nix/pull/12798) + [#12773](https://github.com/NixOS/nix/pull/12773) + + Now the C++ interface confirms to common conventions much better than before: + + - All headers are expected to be included with the initial `nix/`, e.g. as `#include "nix/....hh"` (what Nix's headers now do) or `#include ` (what downstream projects may choose to do). + Likewise, the pkg-config files have `-I${includedir}` not `-I${includedir}/nix` or similar. + + Including without the `nix/` like before sometimes worked because of how for `#include` C pre-process checks the directory containing the current file, not just the lookup path, but this was not reliable. + + - All configuration headers are included explicitly by the (regular) headers that need them. + There is no more need to pass `-include` to force additional files to be included. + + - The public, installed configuration headers no longer contain implementation-specific details that are not relevant to the API. + The vast majority of definitions that were previously in there are now moved to new private, non-installed configuration headers. + The renaming definitions now all start with `NIX_`. + + - The name of the Nix component the header comes from + (e.g. `util`, `store`, `expr`, `flake`, etc.) + is now part of the path to the header, coming after `nix` and before the header name + (or rest of the header path, if it is already in a directory). + + Here is a contrived diff showing a few of these changes at once: + + ```diff + @@ @@ + -#include "derived-path.hh" + +#include "nix/store/derived-path.hh" + @@ @@ + +// Would include for the variables used before. But when other headers + +// need these variables. those will include these config themselves. + +#include "nix/store/config.hh" + +#include "nix/expr/config.hh" + @@ @@ + -#include "config.hh" + +// Additionally renamed to distinguish from components' config headers. + +#include "nix/util/configuration.hh" + @@ @@ + -#if HAVE_ACL_SUPPORT + +#if NIX_SUPPORT_ACL + @@ @@ + -#if HAVE_BOEHMGC + +#if NIX_USE_BOEHMGC + @@ @@ + #endif + #endif + @@ @@ + -const char *s = "hi from " SYSTEM; + +const char *s = "hi from " NIX_LOCAL_SYSTEM; + ``` + +- C API `nix_flake_init_global` removed [#5638](https://github.com/NixOS/nix/issues/5638) [#12759](https://github.com/NixOS/nix/pull/12759) + + In order to improve the modularity of the code base, we are removing a use of global state, and therefore the `nix_flake_init_global` function. + + Instead, use `nix_flake_settings_add_to_eval_state_builder`. + For example: + + ```diff + - nix_flake_init_global(ctx, settings); + - HANDLE_ERROR(ctx); + - + nix_eval_state_builder * builder = nix_eval_state_builder_new(ctx, store); + HANDLE_ERROR(ctx); + + + nix_flake_settings_add_to_eval_state_builder(ctx, settings, builder); + + HANDLE_ERROR(ctx); + ``` + + We figured it would be good to do this API change at the same time, also. + +# Contributors + +Querying GitHub API for ce8b1eb2c4735b0bb6e65760c935daf0b8605a8b, to get handle for oldshensheep@gmail.com From f261c03686d95eca9c92be93168aec0dece435bf Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Wed, 2 Apr 2025 22:59:58 +0200 Subject: [PATCH 2/5] chore: Update contributor handle caches (cherry picked from commit 6687ce2a6dcddda457438228ffdc84f300393759) --- maintainers/data/release-credits-email-to-handle.json | 9 ++++++++- maintainers/data/release-credits-handle-to-name.json | 6 +++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/maintainers/data/release-credits-email-to-handle.json b/maintainers/data/release-credits-email-to-handle.json index 8f5031474..977555278 100644 --- a/maintainers/data/release-credits-email-to-handle.json +++ b/maintainers/data/release-credits-email-to-handle.json @@ -145,5 +145,12 @@ "thebenmachine+git@gmail.com": "bmillwood", "leandro@kip93.net": "kip93", "hello@briancamacho.me": "b-camacho", - "bcamacho@anduril.com": "bcamacho2" + "bcamacho@anduril.com": "bcamacho2", + "oldshensheep@gmail.com": "oldshensheep", + "thomasmiedema@gmail.com": "thomie", + "xokdvium@proton.me": "xokdvium", + "kaction@disroot.org": "KAction", + "serenity@kaction.cc": null, + "dev@erik.work": "Kirens", + "felix@alternativebit.fr": "picnoir" } \ No newline at end of file diff --git a/maintainers/data/release-credits-handle-to-name.json b/maintainers/data/release-credits-handle-to-name.json index 7149149c0..a03a811d4 100644 --- a/maintainers/data/release-credits-handle-to-name.json +++ b/maintainers/data/release-credits-handle-to-name.json @@ -129,5 +129,9 @@ "SomeoneSerge": "Someone", "b-camacho": "Brian Camacho", "MaxHearnden": null, - "kip93": "Leandro Emmanuel Reina Kiperman" + "kip93": "Leandro Emmanuel Reina Kiperman", + "oldshensheep": "Ruby Rose", + "KAction": "Dmitry Bogatov", + "thomie": "Thomas Miedema", + "Kirens": "Erik Nygren" } \ No newline at end of file From 93248bd92cb61dabd2c783aaa34b46569a6a9de7 Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Wed, 2 Apr 2025 23:02:27 +0200 Subject: [PATCH 3/5] doc/rl-2.28: Add contributors (cherry picked from commit fea87a94e61e15c8939f912c9ac3647e4947bf64) --- doc/manual/source/release-notes/rl-2.28.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/doc/manual/source/release-notes/rl-2.28.md b/doc/manual/source/release-notes/rl-2.28.md index 701b40590..90f4f1d68 100644 --- a/doc/manual/source/release-notes/rl-2.28.md +++ b/doc/manual/source/release-notes/rl-2.28.md @@ -88,4 +88,22 @@ But we don't want to to release with arbitrary new changes form master, so close # Contributors -Querying GitHub API for ce8b1eb2c4735b0bb6e65760c935daf0b8605a8b, to get handle for oldshensheep@gmail.com +This earlier-than-usual release was made possible by the following 16 contributors: + +- Farid Zakaria [**(@fzakaria)**](https://github.com/fzakaria) +- Jörg Thalheim [**(@Mic92)**](https://github.com/Mic92) +- Eelco Dolstra [**(@edolstra)**](https://github.com/edolstra) +- Graham Christensen [**(@grahamc)**](https://github.com/grahamc) +- Thomas Miedema [**(@thomie)**](https://github.com/thomie) +- Brian McKenna [**(@puffnfresh)**](https://github.com/puffnfresh) +- Sergei Trofimovich [**(@trofi)**](https://github.com/trofi) +- Dmitry Bogatov [**(@KAction)**](https://github.com/KAction) +- Erik Nygren [**(@Kirens)**](https://github.com/Kirens) +- John Ericson [**(@Ericson2314)**](https://github.com/Ericson2314) +- Sergei Zimmerman [**(@xokdvium)**](https://github.com/xokdvium) +- Ruby Rose [**(@oldshensheep)**](https://github.com/oldshensheep) +- Robert Hensing [**(@roberth)**](https://github.com/roberth) +- jade [**(@lf-)**](https://github.com/lf-) +- Félix [**(@picnoir)**](https://github.com/picnoir) +- Valentin Gagarin [**(@fricklerhandwerk)**](https://github.com/fricklerhandwerk) +- Dmitry Bogatov From 4ac9bc08eae6b005f1447742407018a65c58146a Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Wed, 2 Apr 2025 23:05:37 +0200 Subject: [PATCH 4/5] Fix maintainers/release-credits output (cherry picked from commit b87b3d79f24581ef11cbdc0f09aab14d1cdd62e7) --- maintainers/release-credits | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/maintainers/release-credits b/maintainers/release-credits index 7a5c87d7d..10ffd48b5 100755 --- a/maintainers/release-credits +++ b/maintainers/release-credits @@ -109,15 +109,15 @@ for sample in samples: s = samples[sample] email = s["email"] if not email in email_to_handle_cache.values: - print(f"Querying GitHub API for {s['hash']}, to get handle for {s['email']}") + print(f"Querying GitHub API for {s['hash']}, to get handle for {s['email']}", file=sys.stderr) ghc = get_github_commit(samples[sample]) gha = ghc["author"] if gha and gha["login"]: handle = gha["login"] - print(f"Handle: {handle}") + print(f"Handle: {handle}", file=sys.stderr) email_to_handle_cache.values[email] = handle else: - print(f"Found no handle for {s['email']}") + print(f"Found no handle for {s['email']}", file=sys.stderr) email_to_handle_cache.values[email] = None handle = email_to_handle_cache.values[email] if handle is not None: From 78e2832d7d2492afba8f0fa064fe1ddccfbab537 Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Wed, 2 Apr 2025 23:44:30 +0200 Subject: [PATCH 5/5] Edit rl-2.28 (cherry picked from commit 1ca3ee12873cf19579fbecd264c8bca4fee251df) --- doc/manual/source/release-notes/rl-2.28.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/doc/manual/source/release-notes/rl-2.28.md b/doc/manual/source/release-notes/rl-2.28.md index 90f4f1d68..6da09546e 100644 --- a/doc/manual/source/release-notes/rl-2.28.md +++ b/doc/manual/source/release-notes/rl-2.28.md @@ -1,15 +1,10 @@ # Release 2.28.0 (2025-04-02) -This is an atypical release -- instead of being branched off from `master`, it is branched off from the 2.27.x maintenance branch. -The purpose of this is to satisfy both these goals: +This is an atypical release, and for almost all intents and purposes, it is just a continuation of 2.27; not a feature release. -- Release with number of API-breaking changes that are not suitable to backport to 2.27 +We had originally set the goal of making 2.27 the Nixpkgs default for NixOS 25.05, but dependents that link to Nix need certain _interface breaking_ changes in the C++ headers. This is not something we should do in a patch release, so this is why we branched 2.28 right off 2.27 instead of `master`. -- Do not Release with arbitrary new commits from master - -The reason for the combinations of these goals is that we would like this version of Nix to the default in Nixpkgs 25.05, yet, we are getting close to the Nixpkgs 25.05 version freeze. -These API changes complete the big infrastructure rework that accompanies the switch to Meson --- we want to batch all these changes together so there is one round of breakage. -But we don't want to to release with arbitrary new changes form master, so close to a major release, before those changes have had time to "incubate". +This completes the infrastructure overhaul for the [RFC 132](https://github.com/NixOS/rfcs/blob/master/rfcs/0132-meson-builds-nix.md) switchover to meson as our build system. ## Major changes @@ -29,8 +24,8 @@ But we don't want to to release with arbitrary new changes form master, so close There is no more need to pass `-include` to force additional files to be included. - The public, installed configuration headers no longer contain implementation-specific details that are not relevant to the API. - The vast majority of definitions that were previously in there are now moved to new private, non-installed configuration headers. - The renaming definitions now all start with `NIX_`. + The vast majority of definitions that were previously in there are now moved to new headers that are not installed, but used during Nix's own compilation only. + The remaining macro definitions are renamed to have `NIX_` as a prefix. - The name of the Nix component the header comes from (e.g. `util`, `store`, `expr`, `flake`, etc.) @@ -84,7 +79,8 @@ But we don't want to to release with arbitrary new changes form master, so close + HANDLE_ERROR(ctx); ``` - We figured it would be good to do this API change at the same time, also. + Although this change is not as critical, we figured it would be good to do this API change at the same time, also. + Also note that we try to keep the C API compatible, but we decided to break this function because it was young and likely not in widespread use yet. This frees up time to make important progress on the rest of the C API. # Contributors