diff options
author | pennae <github@quasiparticle.net> | 2022-12-30 20:43:53 +0100 |
---|---|---|
committer | pennae <82953136+pennae@users.noreply.github.com> | 2023-01-05 02:33:13 +0100 |
commit | 4c1cfbdb844babe1054c7f365eac337396092d60 (patch) | |
tree | 1217ab10980ba73615c462c2761388dbd808a0db /lib/modules.nix | |
parent | b2054d3f2d900b1f37639e654624f745d4191fe6 (diff) | |
download | nixpkgs-4c1cfbdb844babe1054c7f365eac337396092d60.tar nixpkgs-4c1cfbdb844babe1054c7f365eac337396092d60.tar.gz nixpkgs-4c1cfbdb844babe1054c7f365eac337396092d60.tar.bz2 nixpkgs-4c1cfbdb844babe1054c7f365eac337396092d60.tar.lz nixpkgs-4c1cfbdb844babe1054c7f365eac337396092d60.tar.xz nixpkgs-4c1cfbdb844babe1054c7f365eac337396092d60.tar.zst nixpkgs-4c1cfbdb844babe1054c7f365eac337396092d60.zip |
modules: add mkAliasOptionModuleMD
mkAliasOptionModule should not default to mdDoc descriptions because that can break out-of-tree users of documentation infrastructure. add an explicitly-MD variant for now, to be removed some time after the MD transition is complete.
Diffstat (limited to 'lib/modules.nix')
-rw-r--r-- | lib/modules.nix | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/lib/modules.nix b/lib/modules.nix index caabfee5710..166c24a3a05 100644 --- a/lib/modules.nix +++ b/lib/modules.nix @@ -1108,6 +1108,15 @@ rec { visible = true; warn = false; use = id; + wrapDescription = lib.id; + }; + + /* Transitional version of mkAliasOptionModule that uses MD docs. */ + mkAliasOptionModuleMD = from: to: doRename { + inherit from to; + visible = true; + warn = false; + use = id; }; /* mkDerivedConfig : Option a -> (a -> Definition b) -> Definition b @@ -1130,7 +1139,7 @@ rec { (opt.highestPrio or defaultOverridePriority) (f opt.value); - doRename = { from, to, visible, warn, use, withPriority ? true }: + doRename = { from, to, visible, warn, use, withPriority ? true, wrapDescription ? lib.mdDoc }: { config, options, ... }: let fromOpt = getAttrFromPath from options; @@ -1141,7 +1150,7 @@ rec { { options = setAttrByPath from (mkOption { inherit visible; - description = lib.mdDoc "Alias of {option}`${showOption to}`."; + description = wrapDescription "Alias of {option}`${showOption to}`."; apply = x: use (toOf config); } // optionalAttrs (toType != null) { type = toType; |