rl-2311: Add release notes on lib #268871

infinisil · 2023-11-21T05:23:34Z

Description of changes

NixOS releases are also lib releases :).
As the main lib maintainer, here are the release notes for it.
These were collected from looking at the git diff since 22.11.

I boldly inserted them at the very front, because compared to all the package updates, lib may contain functions that everybody uses.

This work is sponsored by Antithesis ✨

Things done

Built the manual

infinisil · 2023-11-21T05:26:55Z

I notably didn't include these notes on lib.systems, because I'm not maintaining that and barely understand it:

Expand for drafty lib.systems release notes

Platforms

Added lib.systems.equals
GCC feature support for architectures x86-64, x86-64-v2, x86-64-v3, x86-64-v4, nehalem, alderlake and znver4
Better support for Rust cross compilation (mesa: fix cross compilation to x86_64 #233628)
New elaborated platform properties:
- hasSharedLibraries
- ubootArch
New doubles:
- "mips-linux" "mips64-linux" "mips-none" "mips64-none"
New platforms:
- bluefield2
New examples:
- bluefield2
- gnu64_simplekernel
- mips64-embedded
- mips-embedded
Removed examples:
- mipsisa32r6-linux-gnu
- mipsisa32r6el-linux-gnu
- mipsisa64r6-linux-gnuabin32
- mipsisa64r6el-linux-gnuabin32
- mipsisa64r6-linux-gnuabi64
- mipsisa64r6el-linux-gnuabi64

Ping @alyssais @Ericson2314 @amjoseph-nixpkgs

infinisil · 2023-11-21T05:50:40Z

nixos/doc/manual/release-notes/rl-2311.section.md

+- The internal NixOS transition to Markdown documentation is now complete,
+  as such, these functions are not necessary anymore:
+  - `mkAliasOptionModuleMD` is now just an alias to `mkAliasOptionModule`
+  - `mkPackageOptionMD` is now just an alias to `mkPackageOption`
+  - `mdDoc` is now the same as its argument
+  - `literalDocBook` is now removed after deprecation in 22.11


Ping @pennae. Is this accurate or should this be moved to some more internal section?

literalDocBook being gone should be here, the others maybe not quite for this release. 23.05 will be around for a bit after 23.11 is released, so there'll be some overlap where out-of-tree modules will still need to use those aliases if they want to be compatible with both. not sure how relevant that is in practice, maybe it'll be enough to just add a note that all of these should still be used until 23.05 is EOL?

Ah yeah, I think it's best to just remove the mention for these then. I only kept the removal note on literalDocBook around, the others are removed now.

alejandrosame

LGTM, just please move the whole block to the end of the file and we'll edit it appropriately with nixpkgs internal section afterwards.

infinisil · 2023-11-21T16:39:39Z

Moved it to the bottom for now, but these lib changes should not go under "internal" changes. They are a stable and exposed API. I also think that generally curated release notes should go over non-curated ones.

roberth · 2023-11-21T16:50:06Z

nixos/doc/manual/release-notes/rl-2311.section.md

+
+- `lib.meta.getExe pkg` now gives a warning if `pkg.meta.mainProgram` is not set,
+  but it continues to default to the derivation name.
+  Use `lib.meta.getExe' pkg "someBinary"` to avoid the warning and/or select a different binary.


Suggested change

Use `lib.meta.getExe' pkg "someBinary"` to avoid the warning and/or select a different binary.

Nixpkgs accepts PRs that set `meta.mainProgram` on packages where it makes sense.

Use `lib.meta.getExe' pkg "some-command"` to avoid the warning and/or select a different executable.

Ideally we have better data: more mainPrograms.
Nits:

commands tend to be lower snake case

avoid "binary" because scripts aren't binaries (/bin is very very unfortunate)

lib.meta.getExe is annoying. Do we really want people to type that?
Sublibraries are cool, but everyone writes lib.getExe.

Applied your suggestion, also added a mention that it's also available as lib.getExe.

For the future we should figure out a clear policy about which symbols to re-export under lib.*, so we aren't struggling with this, but not today :)

roberth · 2023-11-21T16:57:10Z

nixos/doc/manual/release-notes/rl-2311.section.md

+- [`lib.fixedPoints.fix`](https://nixos.org/manual/nixpkgs/unstable#function-library-lib.fixedPoints.fix) has improved documentation.
+- [`lib.lists.foldl'`](https://nixos.org/manual/nixpkgs/unstable#function-library-lib.lists.foldl-prime) has improved documentation.


This should be in a section of its own, because the functions did not change and mentioning it serves a different purpose.

Now moved to a more general section: #268871 (comment)

infinisil · 2023-11-21T18:06:16Z

nixos/doc/manual/release-notes/rl-2311.section.md

+
+## Nixpkgs library changes {#sec-release-23.11-lib}
+
+### Additions and improvements {#sec-release-23.11-lib-additions-improvements}


@roberth I restructured it into just two sections instead now, one of them is here, and includes both new stuff but also improvements to stuff (intentionally not being specific what "stuff" is, so it can also include docs)

infinisil · 2023-11-22T20:51:56Z

Ping @roberth, does it look good now?

Also @alejandrosame, do you want to merge this yourself or can I do that myself? (and then backport)

alejandrosame · 2023-11-22T20:57:20Z

Ping @roberth, does it look good now?

Also @alejandrosame, do you want to merge this yourself or can I do that myself? (and then backport)

Please, merge it. I'm away for quite some time today (plus, not sure I really have merge rights for this)

roberth

Prioritization and a typo. LGTM after that.

roberth · 2023-11-23T18:19:01Z

nixos/doc/manual/release-notes/rl-2311.section.md

+Module system:
+- `lib.types.string` is now fully deprecated and gives a warning when used.
+- Now that the internal NixOS transition to Markdown documentation is complete,
+  `lib.options.literalDocBook` is has been removed after deprecation in 22.11.


Suggested change

`lib.options.literalDocBook` is has been removed after deprecation in 22.11.

`lib.options.literalDocBook` has been removed after deprecation in 22.11.

roberth · 2023-11-23T18:20:05Z

nixos/doc/manual/release-notes/rl-2311.section.md

+  Not to be confused with `definitionsWithLocations`, which is the same but for option _definitions_.
+- Improved error message for option declarations missing `mkOption`
+
+### Breaking changes and deprecations {#sec-release-23.11-lib-breaking-changes-deprecations}


Breaking changes should go first, not last.

roberth · 2023-11-23T18:21:58Z

nixos/doc/manual/release-notes/rl-2311.section.md

+- `lib.meta.getExe pkg` (also available as `lib.getExe`) now gives a warning if `pkg.meta.mainProgram` is not set,
+  but it continues to default to the derivation name.
+  Nixpkgs accepts PRs that set `meta.mainProgram` on packages where it makes sense.
+  Use `lib.getExe' pkg "some-command"` to avoid the warning and/or select a different executable.


Changes with a proper migration path (deprecations in logs, as well as good error messages) should be demoted to a section that almost all readers can skip, or just omitted.

NixOS releases are also `lib` releases :) The release notes were collected from looking at the `git diff` since 22.11. Since the NixOS and Nixpkgs manuals are rendered separately, I'm linking to the "unstable" link to make sure the links definitely work on the time of release. The "stable" link might take some time to become available

infinisil · 2023-11-23T20:15:17Z

@roberth Done! (diff)

"Please merge it"

roberth

Awesome.

github-actions · 2023-11-23T22:21:58Z

Successfully created backport PR for release-23.11:

[Backport release-23.11] rl-2311: Add release notes on lib #269509

github-actions bot added 6.topic: nixos 8.has: documentation 8.has: changelog labels Nov 21, 2023

infinisil requested review from RaitoBezarius, alejandrosame, figsoda and riotbib November 21, 2023 05:27

infinisil force-pushed the release-notes-lib branch from 31cb5d3 to bb9e7a7 Compare November 21, 2023 05:30

infinisil requested a review from roberth November 21, 2023 05:41

infinisil force-pushed the release-notes-lib branch from bb9e7a7 to 992e9ac Compare November 21, 2023 05:49

infinisil commented Nov 21, 2023

View reviewed changes

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Nov 21, 2023

infinisil added the 6.topic: lib The Nixpkgs function library label Nov 21, 2023

alejandrosame previously requested changes Nov 21, 2023

View reviewed changes

infinisil force-pushed the release-notes-lib branch from 992e9ac to eb59086 Compare November 21, 2023 16:37

github-actions bot removed the 6.topic: lib The Nixpkgs function library label Nov 21, 2023

roberth previously requested changes Nov 21, 2023

View reviewed changes

infinisil force-pushed the release-notes-lib branch from eb59086 to bcf49a1 Compare November 21, 2023 18:04

infinisil commented Nov 21, 2023

View reviewed changes

infinisil force-pushed the release-notes-lib branch 2 times, most recently from ec12700 to 69549df Compare November 22, 2023 00:07

infinisil added this to the 23.11 milestone Nov 22, 2023

alejandrosame closed this Nov 22, 2023

alejandrosame reopened this Nov 22, 2023

roberth reviewed Nov 23, 2023

View reviewed changes

infinisil force-pushed the release-notes-lib branch from 69549df to 38664f7 Compare November 23, 2023 20:14

roberth approved these changes Nov 23, 2023

View reviewed changes

roberth merged commit 1183269 into NixOS:master Nov 23, 2023
5 of 6 checks passed

infinisil deleted the release-notes-lib branch November 23, 2023 21:36

infinisil added the backport release-23.11 label Nov 23, 2023

github-actions bot mentioned this pull request Nov 23, 2023

[Backport release-23.11] rl-2311: Add release notes on lib #269509

Merged

1 task

alejandrosame mentioned this pull request Nov 26, 2023

rl-23.11: New outline proposal #270257

Closed

infinisil mentioned this pull request Dec 1, 2023

Use stable Nixpkgs URLs in release notes #271343

Merged

1 task

infinisil mentioned this pull request Apr 16, 2024

NixOS 24.05 — Feature Freeze & Release Blockers #303286

Closed

39 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rl-2311: Add release notes on lib #268871

rl-2311: Add release notes on lib #268871

infinisil commented Nov 21, 2023 •

edited

Loading

infinisil commented Nov 21, 2023 •

edited

Loading

Platforms

infinisil Nov 21, 2023 •

edited

Loading

pennae Nov 21, 2023

infinisil Nov 21, 2023 •

edited

Loading

alejandrosame left a comment •

edited

Loading

infinisil commented Nov 21, 2023

roberth Nov 21, 2023

roberth Nov 21, 2023

infinisil Nov 21, 2023

roberth Nov 21, 2023

infinisil Nov 21, 2023

infinisil Nov 21, 2023

infinisil commented Nov 22, 2023

alejandrosame commented Nov 22, 2023

roberth left a comment

roberth Nov 23, 2023

roberth Nov 23, 2023

roberth Nov 23, 2023

infinisil commented Nov 23, 2023

roberth left a comment

github-actions bot commented Nov 23, 2023

	Use `lib.meta.getExe' pkg "someBinary"` to avoid the warning and/or select a different binary.
	Nixpkgs accepts PRs that set `meta.mainProgram` on packages where it makes sense.
	Use `lib.meta.getExe' pkg "some-command"` to avoid the warning and/or select a different executable.

		- [`lib.fixedPoints.fix`](https://nixos.org/manual/nixpkgs/unstable#function-library-lib.fixedPoints.fix) has improved documentation.
		- [`lib.lists.foldl'`](https://nixos.org/manual/nixpkgs/unstable#function-library-lib.lists.foldl-prime) has improved documentation.


		## Nixpkgs library changes {#sec-release-23.11-lib}

		### Additions and improvements {#sec-release-23.11-lib-additions-improvements}

	`lib.options.literalDocBook` is has been removed after deprecation in 22.11.
	`lib.options.literalDocBook` has been removed after deprecation in 22.11.

rl-2311: Add release notes on lib #268871

rl-2311: Add release notes on lib #268871

Conversation

infinisil commented Nov 21, 2023 • edited Loading

Description of changes

Things done

infinisil commented Nov 21, 2023 • edited Loading

Platforms

infinisil Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

infinisil Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

alejandrosame left a comment • edited Loading

Choose a reason for hiding this comment

infinisil commented Nov 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

infinisil commented Nov 22, 2023

alejandrosame commented Nov 22, 2023

roberth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

infinisil commented Nov 23, 2023

roberth left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 23, 2023

infinisil commented Nov 21, 2023 •

edited

Loading

infinisil commented Nov 21, 2023 •

edited

Loading

infinisil Nov 21, 2023 •

edited

Loading

infinisil Nov 21, 2023 •

edited

Loading

alejandrosame left a comment •

edited

Loading