From 7c5a5b347459be9df4a52b4e4eba3a7205bde42e Mon Sep 17 00:00:00 2001 From: Dimitar Nestorov <8790386+dimitarnestorov@users.noreply.github.com> Date: Wed, 11 Dec 2024 20:24:47 +0200 Subject: [PATCH] doc: titanium tombstone --- doc/manual.md.in | 4 ++++ doc/redirects.json | 21 +++++++++++++++++++ doc/release-notes/release-notes.md | 7 +++++++ doc/release-notes/rl-2505.section.md | 19 +++++++++++++++++ nixos/doc/manual/default.nix | 2 ++ nixos/doc/manual/redirects.json | 20 ++++++++++++++---- .../manual/release-notes/rl-2505.section.md | 16 +++++--------- 7 files changed, 74 insertions(+), 15 deletions(-) create mode 100644 doc/release-notes/release-notes.md create mode 100644 doc/release-notes/rl-2505.section.md diff --git a/doc/manual.md.in b/doc/manual.md.in index e5f58a23a39951..07e587190d8469 100644 --- a/doc/manual.md.in +++ b/doc/manual.md.in @@ -14,3 +14,7 @@ development.md contributing.md interoperability.md ``` + +```{=include=} appendix html:into-file=//release-notes.html +release-notes/release-notes.md +``` diff --git a/doc/redirects.json b/doc/redirects.json index 7db27031326ed5..a3b2090ad342aa 100644 --- a/doc/redirects.json +++ b/doc/redirects.json @@ -1,4 +1,7 @@ { + "chap-release-notes": [ + "release-notes.html#chap-release-notes" + ], "nixpkgs-manual": [ "index.html#nixpkgs-manual" ], @@ -50,6 +53,24 @@ "chap-overlays": [ "index.html#chap-overlays" ], + "sec-nixpkgs-release-25.05": [ + "release-notes.html#sec-nixpkgs-release-25.05" + ], + "sec-nixpkgs-release-25.05-incompatibilities": [ + "release-notes.html#sec-nixpkgs-release-25.05-incompatibilities" + ], + "sec-nixpkgs-release-25.05-incompatibilities-titanium-removed": [ + "release-notes.html#sec-nixpkgs-release-25.05-incompatibilities-titanium-removed", + "index.html#titanium", + "index.html#building-a-titanium-app", + "index.html#emulating-or-simulating-the-app" + ], + "sec-nixpkgs-release-25.05-lib": [ + "release-notes.html#sec-nixpkgs-release-25.05-lib" + ], + "sec-nixpkgs-release-25.05-lib-breaking": [ + "release-notes.html#sec-nixpkgs-release-25.05-lib-breaking" + ], "sec-overlays-install": [ "index.html#sec-overlays-install" ], diff --git a/doc/release-notes/release-notes.md b/doc/release-notes/release-notes.md new file mode 100644 index 00000000000000..454ea7c50a9ed9 --- /dev/null +++ b/doc/release-notes/release-notes.md @@ -0,0 +1,7 @@ +# Release Notes {#chap-release-notes} + +This section lists the release notes for each stable version of Nixpkgs and current unstable revision. + +```{=include=} sections +rl-2505.section.md +``` diff --git a/doc/release-notes/rl-2505.section.md b/doc/release-notes/rl-2505.section.md new file mode 100644 index 00000000000000..9fa72cc1f484f2 --- /dev/null +++ b/doc/release-notes/rl-2505.section.md @@ -0,0 +1,19 @@ +# Nixpkgs 25.05 (2025.05/??) {#sec-nixpkgs-release-25.05} + +## Backward Incompatibilities {#sec-nixpkgs-release-25.05-incompatibilities} + + + + + +### Titanium removed {#sec-nixpkgs-release-25.05-incompatibilities-titanium-removed} + +- `titaniumenv`, `titanium`, and `titanium-alloy` have been removed due to lack of maintenance in Nixpkgs. + +## Nixpkgs Library {#sec-nixpkgs-release-25.05-lib} + +### Breaking changes {#sec-nixpkgs-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. diff --git a/nixos/doc/manual/default.nix b/nixos/doc/manual/default.nix index 177a05b3753281..7ab02b9f2c370b 100644 --- a/nixos/doc/manual/default.nix +++ b/nixos/doc/manual/default.nix @@ -79,6 +79,8 @@ let prepareManualFromMD = '' cp -r --no-preserve=all $inputs/* . + cp -r ${../../../doc/release-notes} ./release-notes-nixpkgs + substituteInPlace ./manual.md \ --replace-fail '@NIXOS_VERSION@' "${version}" substituteInPlace ./configuration/configuration.md \ diff --git a/nixos/doc/manual/redirects.json b/nixos/doc/manual/redirects.json index 6f897ce7a99175..d8175badcc3490 100644 --- a/nixos/doc/manual/redirects.json +++ b/nixos/doc/manual/redirects.json @@ -1844,11 +1844,23 @@ "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-nixpkgs-release-25.05": [ + "release-notes.html#sec-nixpkgs-release-25.05" ], - "sec-release-25.05-lib-breaking": [ - "release-notes.html#sec-release-25.05-lib-breaking" + "sec-nixpkgs-release-25.05-incompatibilities": [ + "release-notes.html#sec-nixpkgs-release-25.05-incompatibilities" + ], + "sec-nixpkgs-release-25.05-incompatibilities-titanium-removed": [ + "release-notes.html#sec-nixpkgs-release-25.05-incompatibilities-titanium-removed", + "index.html#titanium", + "index.html#building-a-titanium-app", + "index.html#emulating-or-simulating-the-app" + ], + "sec-nixpkgs-release-25.05-lib": [ + "release-notes.html#sec-nixpkgs-release-25.05-lib" + ], + "sec-nixpkgs-release-25.05-lib-breaking": [ + "release-notes.html#sec-nixpkgs-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 4ca2439f2daaff..c842b8aebcc3f8 100644 --- a/nixos/doc/manual/release-notes/rl-2505.section.md +++ b/nixos/doc/manual/release-notes/rl-2505.section.md @@ -45,8 +45,8 @@ and `withGstreamer`/`withVlc` override options have been removed due to this. - `timescaledb` requires manual upgrade steps. - After you run ALTER EXTENSION, you must run [this SQL script](https://github.com/timescale/timescaledb-extras/blob/master/utils/2.15.X-fix_hypertable_foreign_keys.sql). For more details, see the following pull requests [#6797](https://github.com/timescale/timescaledb/pull/6797). - PostgreSQL 13 is no longer supported in TimescaleDB v2.16. + After you run ALTER EXTENSION, you must run [this SQL script](https://github.com/timescale/timescaledb-extras/blob/master/utils/2.15.X-fix_hypertable_foreign_keys.sql). For more details, see the following pull requests [#6797](https://github.com/timescale/timescaledb/pull/6797). + PostgreSQL 13 is no longer supported in TimescaleDB v2.16. - Support for CUDA 10 has been dropped, as announced in the 24.11 release notes. @@ -87,8 +87,6 @@ - `nodePackages.ganache` has been removed, as the package has been deprecated by upstream. -- `titaniumenv`, `titanium`, and `titanium-alloy` have been removed due to lack of maintenance in Nixpkgs. - - `containerd` has been updated to v2, which contains breaking changes. See the [containerd 2.0](https://github.com/containerd/containerd/blob/main/docs/containerd-2.0.md) documentation for more details. @@ -121,10 +119,6 @@ -## 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. +```{=include=} sections +../release-notes-nixpkgs/rl-2505.section.md +```