Skip to content

Commit

Permalink
doc: titanium tombstone
Browse files Browse the repository at this point in the history
  • Loading branch information
DimitarNestorov authored and fricklerhandwerk committed Jan 2, 2025
1 parent 9516e69 commit 10a75ab
Show file tree
Hide file tree
Showing 7 changed files with 72 additions and 13 deletions.
4 changes: 4 additions & 0 deletions doc/manual.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ development.md
contributing.md
interoperability.md
```

```{=include=} appendix html:into-file=//release-notes.html
release-notes/release-notes.md
```
21 changes: 21 additions & 0 deletions doc/redirects.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"chap-release-notes": [
"release-notes.html#chap-release-notes"
],
"nixpkgs-manual": [
"index.html#nixpkgs-manual"
],
Expand Down Expand Up @@ -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"
],
Expand Down
7 changes: 7 additions & 0 deletions doc/release-notes/release-notes.md
Original file line number Diff line number Diff line change
@@ -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
```
19 changes: 19 additions & 0 deletions doc/release-notes/rl-2505.section.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Nixpkgs 25.05 (2025.05/??) {#sec-nixpkgs-release-25.05}

## Backward Incompatibilities {#sec-nixpkgs-release-25.05-incompatibilities}

<!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

<!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

### 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.
2 changes: 2 additions & 0 deletions nixos/doc/manual/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
20 changes: 16 additions & 4 deletions nixos/doc/manual/redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -1886,11 +1886,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"
Expand Down
12 changes: 3 additions & 9 deletions nixos/doc/manual/release-notes/rl-2505.section.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,6 @@

- `docker_24` has been removed, as it was EOL with vulnerabilites since June 08, 2024.

- `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.
Expand Down Expand Up @@ -342,10 +340,6 @@

<!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

## 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
```

0 comments on commit 10a75ab

Please sign in to comment.