From c1d7850f85eaedbe8ebe13205f90865ca1361d31 Mon Sep 17 00:00:00 2001 From: Malte Brandy Date: Tue, 7 Jan 2020 22:27:03 +0100 Subject: Improve documentation for stateVersion The meaning of stateVersion often leads to a lot of confusion. This commit trys to improve that situation. --- nixos/modules/installer/tools/tools.nix | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'nixos/modules/installer/tools/tools.nix') 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? } -- cgit 1.4.1