From 1aaa1a033bae6c53773ad4374756ac72ba25b729 Mon Sep 17 00:00:00 2001
From: Nicolas Berbiche <nicolas@normie.dev>
Date: Wed, 1 Dec 2021 23:22:41 -0500
Subject: [PATCH] docs: add note about Waybar modules

---
 docs/release-notes/rl-2111.adoc | 16 ++++++++++++++--
 docs/release-notes/rl-2205.adoc | 16 ++++++++++++++--
 modules/misc/news.nix           | 11 +++++++++++
 3 files changed, 39 insertions(+), 4 deletions(-)

diff --git a/docs/release-notes/rl-2111.adoc b/docs/release-notes/rl-2111.adoc
index 4287ade1..0ac83a32 100644
--- a/docs/release-notes/rl-2111.adoc
+++ b/docs/release-notes/rl-2111.adoc
@@ -50,12 +50,24 @@ changes are only active if the `home.stateVersion` option is set to
 * The <<opt-home.keyboard>> option now defaults to `null`, meaning that Home Manager won't do any keyboard layout management. For example, `setxkbmap` won't be run in X sessions.
 
 * The <<opt-programs.pet.settings>> option no longer place its value inside a `General` attribute.
-For example, is you before had
+For example,
 +
 [source,nix]
 programs.pet.settings.editor = "nvim";
 +
-then you now need
+becomes
 +
 [source,nix]
 programs.pet.settings.General.editor = "nvim";
+
+* The <<opt-programs.waybar.settings>> option now allows defining modules directly under <<opt-programs.waybar.settings>>.
+For example,
++
+[source,nix]
+programs.waybar.settings.modules."custom/my-module" = { };
++
+becomes
++
+[source,nix]
+programs.waybar.settings."custom/my-module" = { };
+
diff --git a/docs/release-notes/rl-2205.adoc b/docs/release-notes/rl-2205.adoc
index 55420daa..0684bab6 100644
--- a/docs/release-notes/rl-2205.adoc
+++ b/docs/release-notes/rl-2205.adoc
@@ -8,7 +8,8 @@ This is the current unstable branch and the information in this section is there
 
 This release has the following notable changes:
 
-* Nothing has happened.
+* The `programs.waybar.settings.modules` option was removed.
+Waybar modules should now be declared directly under `programs.waybar.settings`.
 
 [[sec-release-22.05-state-version-changes]]
 === State Version Changes
@@ -16,4 +17,15 @@ This release has the following notable changes:
 The state version in this release includes the changes below.
 These changes are only active if the `home.stateVersion` option is set to "22.05" or later.
 
-* Nothing has happened.
+* The <<opt-programs.waybar.settings>> option now allows defining modules directly under <<opt-programs.waybar.settings>>.
+Defining modules under `programs.waybar.settings.modules` will now be an error.
+For example,
++
+[source,nix]
+programs.waybar.settings.modules."custom/my-module" = { };
++
+becomes
++
+[source,nix]
+programs.waybar.settings."custom/my-module" = { };
+
diff --git a/modules/misc/news.nix b/modules/misc/news.nix
index eef1a125..a850bd8d 100644
--- a/modules/misc/news.nix
+++ b/modules/misc/news.nix
@@ -2269,6 +2269,17 @@ in
           macOS.
         '';
       }
+
+      {
+        time = "2021-12-02T02:59:59+00:00";
+        condition = config.programs.waybar.enable;
+        message = ''
+          The Waybar module now allows defining modules directly under the 'settings'
+          option instead of nesting the modules under 'settings.modules'.
+          The Waybar module will also stop reporting errors about unused or misnamed
+          modules.
+        '';
+      }
     ];
   };
 }