docs: add release-notes as appendix

The release notes used to be an appendix in the manual. After
converting to markdown that appendix got lost. This commit
reintroduces the release notes into the manual.

Author: considerate

docs/home-manager-manual.nix

@@ -37,6 +37,8 @@ in stdenv.mkDerivation {
     cp -t out/highlightjs ${nmd}/static/highlightjs/tomorrow-night.min.css
     cp ${./highlight-style.css} out/highlightjs/highlight-style.css
 
+    cp -r ${./release-notes} release-notes
+
     nixos-render-docs manual html \
       --manpage-urls ./manpage-urls.json \
       --revision ${lib.trivial.revisionWithDefault revision} \

docs/manual/manual.md

@@ -28,3 +28,6 @@ nixos-options.md
 ```{=include=} appendix html:into-file=//nix-darwin-options.html
 nix-darwin-options.md
 ```
+```{=include=} appendix html:into-file=//release-notes.xhtml
+release-notes/release-notes.md
+```

docs/release-notes/release-notes.adoc

@@ -0,0 +1,19 @@
+# Release Notes {#ch-release-notes}
+
+This section lists the release notes for stable versions of Home Manager
+and the current unstable version.
+
+```{=include=} chapters
+rl-2405.md
+rl-2311.md
+rl-2305.md
+rl-2211.md
+rl-2205.md
+rl-2111.md
+rl-2105.md
+rl-2009.md
+rl-2003.md
+rl-1909.md
+rl-1903.md
+rl-1809.md
+```

docs/release-notes/release-notes.md

@@ -1,4 +1,3 @@
-[[sec-release-18.09]]
-== Release 18.09
+# Release 18.09 {#sec-release-18.09}
 
 The 18.09 release branch became the stable branch in September, 2018.

docs/release-notes/rl-1809.adoc docs/release-notes/rl-1809.md

@@ -0,0 +1,52 @@
+# Release 19.03 {#sec-release-19.03}
+
+The 19.03 release branch became the stable branch in April, 2019.
+
+## Highlights {#sec-release-19.03-highlights}
+
+This release has the following notable changes:
+
+-   The [opt-home.file._name_.source](#opt-home.file._name_.source) option now allows source
+    files to be hidden, that is, having a name starting with the `.`
+    character. It also allows the source file name to contain characters
+    not typically allowed for Nix store paths. For example, your
+    configuration can now contain things such as
+
+    ``` nix
+    home.file."my file".source = ./. + "/file with spaces!";
+    ```
+
+-   The type used for the systemd unit options under
+    [opt-systemd.user.sockets](#opt-systemd.user.sockets),
+    etc. has been changed to offer more robust merging of
+    configurations. If you don't override values within systemd units
+    then you are not affected by this change. Unfortunately, if you do
+    override unit values you may encounter errors.
+
+    In particular, if you get an error saying that a "unique option" is
+    "defined multiple times" then you need to use the
+    [`mkForce`](https://nixos.org/nixos/manual/#sec-option-definitions-setting-priorities)
+    function. For example,
+
+    ``` nix
+    systemd.user.services.foo.Service.ExecStart = "/foo/bar";
+    ```
+
+    becomes
+
+    ``` nix
+    systemd.user.services.foo.Service.ExecStart = lib.mkForce "/foo/bar";
+    ```
+
+    We had to make this change because the old merging was causing too
+    many confusing situations for people.
+
+## State Version Changes {#sec-release-19.03-state-version-changes}
+
+The state version in this release includes the changes below. These
+changes are only active if the [opt-home.stateVersion](#opt-home.stateVersion) option is
+set to "19.03" or later.
+
+-   There is now an option [opt-programs.beets.enable](#opt-programs.beets.enable) that
+    defaults to `false`. Before the module would be active if the
+    [opt-programs.beets.settings](#opt-programs.beets.settings) option was non-empty.

docs/release-notes/rl-1903.adoc

@@ -0,0 +1,28 @@
+# Release 19.09 {#sec-release-19.09}
+
+The 19.09 release branch became the stable branch in October, 2019.
+
+## Highlights {#sec-release-19.09-highlights}
+
+This release has the following notable changes:
+
+-   The `programs.firefox.enableGoogleTalk` and
+    `programs.firefox.enableIcedTea` options are now deprecated and will
+    only work if Firefox ESR 52.x is used.
+
+-   The `home-manager` tool now provides an `uninstall` sub-command that
+    can be used to uninstall Home Manager, if used in the standalone
+    mode. That is, not as a NixOS module.
+
+## State Version Changes {#sec-release-19.09-state-version-changes}
+
+The state version in this release includes the changes below. These
+changes are only active if the `home.stateVersion` option is set to
+\"19.09\" or later.
+
+-   The [opt-programs.firefox.package](#opt-programs.firefox.package) option now expects a
+    wrapped Firefox package and defaults to `pkgs.firefox`.
+
+-   The options [opt-home.keyboard.layout](#opt-home.keyboard.layout) and
+    [opt-home.keyboard.variant](#opt-home.keyboard.variant) now default to `null`, which
+    indicates that the system value should be used.