Improve documentation for stateVersion

The meaning of stateVersion often leads to a lot of confusion. This commit trys to improve that situation.
2020-01-07 22:27:03 +01:00
parent 82875a20ba
commit c1d7850f85
2 changed files with 15 additions and 6 deletions
@@ -159,10 +159,12 @@ in
        #   extraGroups = [ "wheel" ]; # Enable ‘sudo’ for the user.
        # };

-        # This value determines the NixOS release with which your system is to be
-        # compatible, in order to avoid breaking some software such as database
-        # servers. You should change this only after NixOS release notes say you
-        # should.
+        # This value determines the NixOS release from which the default
+        # settings for stateful data, like file locations and database versions
+        # on your system were taken. It‘s perfectly fine and recommended to leave
+        # this value at the release version of the first install of this system.
+        # Before changing this value read the documentation for this option
+        # (e.g. man configuration.nix or on https://nixos.org/nixos/options.html).
        system.stateVersion = "${config.system.nixos.release}"; # Did you read the comment?

      }