From ef257da52a299a47cc7235da270ab3b427a4ea5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Garniaux?= Date: Thu, 13 Mar 2025 14:50:10 +0100 Subject: [PATCH] docs: enhance comment for home.stateVersion option (#6116) Enhance comment for home.stateVersion option (see issue #5794) --- docs/manual/installation/nixos.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/manual/installation/nixos.md b/docs/manual/installation/nixos.md index 6c9807ee8..6ec201638 100644 --- a/docs/manual/installation/nixos.md +++ b/docs/manual/installation/nixos.md @@ -42,9 +42,15 @@ home-manager.users.eve = { pkgs, ... }: { home.packages = [ pkgs.atool pkgs.httpie ]; programs.bash.enable = true; - # The state version is required and should stay at the version you - # originally installed. - home.stateVersion = "24.11"; + # This value determines the Home Manager release that your configuration is + # compatible with. This helps avoid breakage when a new Home Manager release + # introduces backwards incompatible changes. + # + # You should not change this value, even if you update Home Manager. If you do + # want to update the value, then make sure to first check the Home Manager + # release notes. + home.stateVersion = "24.05"; # Please read the comment before changing. + }; ```