docs: add note about Waybar modules

This commit is contained in:
Nicolas Berbiche 2021-12-01 23:22:41 -05:00 committed by Robert Helgesson
parent 290a188dad
commit 1aaa1a033b
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
3 changed files with 39 additions and 4 deletions

View file

@ -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" = { };

View file

@ -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" = { };

View file

@ -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.
'';
}
];
};
}