modules(isolation): fix description warnings
Tony Olagbaiye
5 days ago
13 | 13 | type = types.nullOr unaryStringFunctionType; |
14 | 14 | example = literalExample ''{ id, ... }: "10.''${id}.0.1"''; |
15 | 15 | default = null; |
16 | description = "Function to make a host IPv4 from a unique scope index"; | |
16 | 17 | }; |
17 | 18 | makeHostAddress6 = mkOption { |
18 | 19 | type = types.nullOr unaryStringFunctionType; |
19 | 20 | example = literalExample ''{ id, ... }: "fc00:''${id}::1"''; |
20 | 21 | default = null; |
22 | description = "Function to make a host IPv6 from a unique scope index"; | |
21 | 23 | }; |
22 | 24 | makeLocalAddress = mkOption { |
23 | 25 | type = types.nullOr unaryStringFunctionType; |
24 | 26 | example = literalExample ''{ id, ... }: "10.''${id}.0.2"''; |
25 | 27 | default = null; |
28 | description = "Function to make a local IPv4 from a unique scope index"; | |
26 | 29 | }; |
27 | 30 | makeLocalAddress6 = mkOption { |
28 | 31 | type = types.nullOr unaryStringFunctionType; |
29 | 32 | example = literalExample ''{ id, ... }: "fc00:''${id}::0"''; |
30 | 33 | default = null; |
34 | description = "Function to make a local IPv6 from a unique scope index"; | |
31 | 35 | }; |
32 | 36 | scopes = mkOption { |
33 | 37 | type = types.attrsOf (types.submodule ({ config, name, ... }: { |
34 | 38 | options = { |
35 | 39 | id = mkOption { |
36 | 40 | type = types.ints.u8; |
41 | description = "Scope identifier"; | |
37 | 42 | }; |
38 | 43 | name = mkOption { |
39 | 44 | type = types.addCheck types.str (name: lib.stringLength name < 12); |
40 | 45 | default = name; |
46 | description = "Scope name"; | |
41 | 47 | }; |
42 | 48 | hostAddress = mkOption { |
43 | 49 | type = types.str; |
50 | description = "Scope IPv4 host address"; | |
44 | 51 | }; |
45 | 52 | hostAddress6 = mkOption { |
46 | 53 | type = types.str; |
54 | description = "Scope IPv6 host address"; | |
47 | 55 | }; |
48 | 56 | localAddress = mkOption { |
49 | 57 | type = types.str; |
58 | description = "Scope IPv4 local address"; | |
50 | 59 | }; |
51 | 60 | localAddress6 = mkOption { |
52 | 61 | type = types.str; |
62 | description = "Scope IPv6 local address"; | |
53 | 63 | }; |
54 | 64 | baseModules = mkOption { |
55 | 65 | type = types.listOf types.anything; |
56 | 66 | default = import (pkgs.path + "/nixos/modules/module-list.nix"); |
67 | description = "Scope base system modules"; | |
57 | 68 | }; |
58 | 69 | extraModules = mkOption { |
59 | 70 | type = types.listOf types.anything; |
71 | description = "Extra scope modules"; | |
60 | 72 | }; |
61 | 73 | nixos = mkOption { |
62 | 74 | type = types.nullOr (types.submoduleWith { |
100 | 112 | common.nixos = mkOption { |
101 | 113 | type = with types; coercedTo anything singleton (listOf anything); |
102 | 114 | default = {}; |
115 | description = "Common configuration between machines"; | |
103 | 116 | }; |
104 | 117 | machines = mkOption { |
105 | 118 | type = types.listOf types.anything; |