clanModules/state-version: improve documentation

This commit is contained in:
a-kenji
2024-09-14 20:00:25 +02:00
parent 09aaee0c63
commit 3a10d9c057

View File

@@ -5,3 +5,11 @@ description = "Automatically generate the state version of the nixos installatio
This module generates the `system.stateVersion` of the nixos installation automatically.
Options: [system.stateVersion](https://search.nixos.org/options?channel=unstable&show=system.stateVersion&from=0&size=50&sort=relevance&type=packages&query=stateVersion)
Migration:
If you are already setting `system.stateVersion`, then import the module and then either let the automatic generation happen, or trigger the generation manually for the machine. The module will take the specified version, if one is already supplied through the config.
To manually generate the version for a specified machine run:
```
clan vars generate [MACHINE]
```