heierbtc/nix-bitcoin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge fort-nix/nix-bitcoin#612: versioning: improve configVersion description

Browse Source 
bed10d1fca versioning: improve `configVersion` description (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  jonasnick:
    ACK bed10d1fca

Tree-SHA512: d43437a368f48628ce975f2154e802110030dcadec3e9de75df5d0d787d021ab1fa0ef20060ee4376e066ebfb83a571a2d18a27a10e4c316db101d5a6151214f
This commit is contained in:
Jonas Nick 2023-06-11 20:02:16 +00:00
commit 47c1a482ef
No known key found for this signature in database
GPG Key ID: 4861DBF262123605
1 changed files with 5 additions and 2 deletions
Show Stats 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.
'';
};
};