aiolabs/nix-bitcoin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

versioning: improve configVersion description

Browse source
This commit is contained in:
Erik Arvstedt 2023-06-09 14:29:29 +02:00
parent e3190b244f
commit bed10d1fca
No known key found for this signature in database
GPG key ID: 33312B944DD97846
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
modules/versioning.nix
View file

@ -11,13 +11,16 @@ let
nix-bitcoin.configVersion = mkOption {
type = with types; nullOr str;
default = null;
example = "0.0.92";
description = mdDoc ''
Set this option to the nix-bitcoin release version that your config is
compatible with.
The nix-bitcoin release version that your config is compatible with.
When upgrading to a backwards-incompatible release, nix-bitcoin will throw an
error during evaluation and provide instructions for migrating your config to
the new release.
Once set, you only need to update this option when explicitly told to in an
error message during evaluation.
'';
};
};