about summary refs log tree commit diff
path: root/nixos/modules/installer
diff options
context:
space:
mode:
authorMalte Brandy <malte.brandy@maralorn.de>2020-01-07 22:27:03 +0100
committerMalte Brandy <malte.brandy@maralorn.de>2020-01-07 22:27:03 +0100
commitc1d7850f85eaedbe8ebe13205f90865ca1361d31 (patch)
treed645d89db0c75cad88b99fdedf45c157448a54ce /nixos/modules/installer
parent82875a20ba444110396f95537b18247898e40e22 (diff)
downloadnixlib-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar
nixlib-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.gz
nixlib-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.bz2
nixlib-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.lz
nixlib-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.xz
nixlib-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.zst
nixlib-c1d7850f85eaedbe8ebe13205f90865ca1361d31.zip
Improve documentation for stateVersion
The meaning of stateVersion often leads to a lot of confusion. This
commit trys to improve that situation.
Diffstat (limited to 'nixos/modules/installer')
-rw-r--r--nixos/modules/installer/tools/tools.nix10
1 files changed, 6 insertions, 4 deletions
diff --git a/nixos/modules/installer/tools/tools.nix b/nixos/modules/installer/tools/tools.nix
index e4db39b5c810..5df9c23e6b69 100644
--- a/nixos/modules/installer/tools/tools.nix
+++ b/nixos/modules/installer/tools/tools.nix
@@ -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?
 
       }