diff options
author | Valentin Gagarin <valentin.gagarin@tweag.io> | 2022-12-02 17:19:40 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-02 17:19:40 +0100 |
commit | 260de5901e5bb56563528794bda6ff10ddddb80a (patch) | |
tree | 0092951e44dd044e0c04d066647378711a25ed3c /lib | |
parent | 6be5bb3172bf4e76efa7a3bc932b34f44240d2dd (diff) | |
parent | e8927c46b8693b1d0b1d6e12cd602c6647217d3a (diff) |
Merge pull request #204103 from ncfavier/doc-mkOrder
nixos/doc: document `mkOrder` and friends
Diffstat (limited to 'lib')
-rw-r--r-- | lib/modules.nix | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/lib/modules.nix b/lib/modules.nix index 23e531de5c3a8..8cc8d67d600b1 100644 --- a/lib/modules.nix +++ b/lib/modules.nix @@ -844,7 +844,7 @@ rec { filterOverrides' = defs: let - getPrio = def: if def.value._type or "" == "override" then def.value.priority else defaultPriority; + getPrio = def: if def.value._type or "" == "override" then def.value.priority else defaultOverridePriority; highestPrio = foldl' (prio: def: min (getPrio def) prio) 9999 defs; strip = def: if def.value._type or "" == "override" then def // { value = def.value.content; } else def; in { @@ -853,7 +853,7 @@ rec { }; /* Sort a list of properties. The sort priority of a property is - 1000 by default, but can be overridden by wrapping the property + defaultOrderPriority by default, but can be overridden by wrapping the property using mkOrder. */ sortProperties = defs: let @@ -862,7 +862,7 @@ rec { then def // { value = def.value.content; inherit (def.value) priority; } else def; defs' = map strip defs; - compare = a: b: (a.priority or 1000) < (b.priority or 1000); + compare = a: b: (a.priority or defaultOrderPriority) < (b.priority or defaultOrderPriority); in sort compare defs'; # This calls substSubModules, whose entire purpose is only to ensure that @@ -898,10 +898,13 @@ rec { mkOptionDefault = mkOverride 1500; # priority of option defaults mkDefault = mkOverride 1000; # used in config sections of non-user modules to set a default + defaultOverridePriority = 100; mkImageMediaOverride = mkOverride 60; # image media profiles can be derived by inclusion into host config, hence needing to override host config, but do allow user to mkForce mkForce = mkOverride 50; mkVMOverride = mkOverride 10; # used by ‘nixos-rebuild build-vm’ + defaultPriority = lib.warnIf (lib.isInOldestRelease 2305) "lib.modules.defaultPriority is deprecated, please use lib.modules.defaultOverridePriority instead." defaultOverridePriority; + mkFixStrictness = lib.warn "lib.mkFixStrictness has no effect and will be removed. It returns its argument unmodified, so you can just remove any calls." id; mkOrder = priority: content: @@ -910,11 +913,9 @@ rec { }; mkBefore = mkOrder 500; + defaultOrderPriority = 1000; mkAfter = mkOrder 1500; - # The default priority for things that don't have a priority specified. - defaultPriority = 100; - # Convenient property used to transfer all definitions and their # properties from one option to another. This property is useful for # renaming options, and also for including properties from another module @@ -941,10 +942,10 @@ rec { # Similar to mkAliasAndWrapDefinitions but copies over the priority from the # option as well. # - # If a priority is not set, it assumes a priority of defaultPriority. + # If a priority is not set, it assumes a priority of defaultOverridePriority. mkAliasAndWrapDefsWithPriority = wrap: option: let - prio = option.highestPrio or defaultPriority; + prio = option.highestPrio or defaultOverridePriority; defsWithPrio = map (mkOverride prio) option.definitions; in mkAliasIfDef option (wrap (mkMerge defsWithPrio)); @@ -1126,7 +1127,7 @@ rec { # to definitions. mkDerivedConfig = opt: f: mkOverride - (opt.highestPrio or defaultPriority) + (opt.highestPrio or defaultOverridePriority) (f opt.value); doRename = { from, to, visible, warn, use, withPriority ? true }: |