public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation for stateVersion

Browse Source 
The meaning of stateVersion often leads to a lot of confusion. This
commit trys to improve that situation.
This commit is contained in:
Malte Brandy
2020-01-07 22:27:03 +01:00
parent 82875a20ba
commit c1d7850f85
2 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
nixos/modules/misc/version.nix
+9 -2
View File
@@ -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.
'';
};