aboutsummaryrefslogtreecommitdiff
path: root/home-manager/modules/misc/version.nix
blob: 18bb28f7603d3a67c7ae17fcb15ebc5bd1d59f6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{ config, lib, ... }:

with lib;

{
  options = {
    home.stateVersion = mkOption {
      type = types.enum [ "18.09" "19.03" "19.09" ];
      default = "18.09";
      description = ''
        It is occasionally necessary for Home Manager to change
        configuration defaults in a way that is incompatible with
        stateful data. This could, for example, include switching the
        default data format or location of a file.
        </para><para>
        The <emphasis>state version</emphasis> indicates which default
        settings are in effect and will therefore help avoid breaking
        program configurations. Switching to a higher state version
        typically requires performing some manual steps, such as data
        conversion or moving files.
      '';
    };
  };
}