diff options
author | Malte Brandy <malte.brandy@maralorn.de> | 2020-01-07 22:27:03 +0100 |
---|---|---|
committer | Malte Brandy <malte.brandy@maralorn.de> | 2020-01-07 22:27:03 +0100 |
commit | c1d7850f85eaedbe8ebe13205f90865ca1361d31 (patch) | |
tree | d645d89db0c75cad88b99fdedf45c157448a54ce /nixos/modules/misc | |
parent | 82875a20ba444110396f95537b18247898e40e22 (diff) | |
download | nixpkgs-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar nixpkgs-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.gz nixpkgs-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.bz2 nixpkgs-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.lz nixpkgs-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.xz nixpkgs-c1d7850f85eaedbe8ebe13205f90865ca1361d31.tar.zst nixpkgs-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/misc')
-rw-r--r-- | nixos/modules/misc/version.nix | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/nixos/modules/misc/version.nix b/nixos/modules/misc/version.nix index 0540b493003..b85614771ee 100644 --- a/nixos/modules/misc/version.nix +++ b/nixos/modules/misc/version.nix @@ -61,11 +61,18 @@ in configuration defaults in a way incompatible with stateful data. For instance, if the default version of PostgreSQL changes, the new version will probably be unable to read your - existing databases. To prevent such breakage, you can set the + existing databases. To prevent such breakage, you should set the value of this option to the NixOS release with which you want - to be compatible. The effect is that NixOS will option + to be compatible. The effect is that NixOS will use defaults corresponding to the specified release (such as using an older version of PostgreSQL). + It‘s perfectly fine and recommended to leave this value at the + release version of the first install of this system. + Changing this option will not upgrade your system. In fact it + is meant to stay constant exactly when you upgrade your system. + You should only bump this option, if you are sure that you can + or have migrated all state on your system which is affected + by this option. ''; }; |