summary refs log tree commit diff
path: root/lib/modules.nix
diff options
context:
space:
mode:
authorNaïm Favier <n@monade.li>2023-01-08 22:41:13 +0100
committerNaïm Favier <n@monade.li>2023-01-08 22:44:18 +0100
commitfb1bc8de93d3c2dba328224a082ecf1ad2fc7fac (patch)
tree13c2def29e8a78f4641bd0b9491c74e6f25f004d /lib/modules.nix
parent6c73595e66ddea69fd40d867d962fa5e9ed06ada (diff)
downloadnixpkgs-fb1bc8de93d3c2dba328224a082ecf1ad2fc7fac.tar
nixpkgs-fb1bc8de93d3c2dba328224a082ecf1ad2fc7fac.tar.gz
nixpkgs-fb1bc8de93d3c2dba328224a082ecf1ad2fc7fac.tar.bz2
nixpkgs-fb1bc8de93d3c2dba328224a082ecf1ad2fc7fac.tar.lz
nixpkgs-fb1bc8de93d3c2dba328224a082ecf1ad2fc7fac.tar.xz
nixpkgs-fb1bc8de93d3c2dba328224a082ecf1ad2fc7fac.tar.zst
nixpkgs-fb1bc8de93d3c2dba328224a082ecf1ad2fc7fac.zip
lib/modules: make `mkAliasOptionModule` emit DocBook
Follow-up to https://github.com/NixOS/nixpkgs/pull/208407

Removing `mdDoc` isn't enough, we need to emit actual DocBook.
Diffstat (limited to 'lib/modules.nix')
-rw-r--r--lib/modules.nix8
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/modules.nix b/lib/modules.nix
index c304d5b9afd..5e6bee6aabe 100644
--- a/lib/modules.nix
+++ b/lib/modules.nix
@@ -1113,7 +1113,6 @@ rec {
     visible = true;
     warn = false;
     use = id;
-    wrapDescription = lib.id;
   };
 
   /* Transitional version of mkAliasOptionModule that uses MD docs. */
@@ -1122,6 +1121,7 @@ rec {
     visible = true;
     warn = false;
     use = id;
+    markdown = true;
   };
 
   /* mkDerivedConfig : Option a -> (a -> Definition b) -> Definition b
@@ -1144,7 +1144,7 @@ rec {
       (opt.highestPrio or defaultOverridePriority)
       (f opt.value);
 
-  doRename = { from, to, visible, warn, use, withPriority ? true, wrapDescription ? lib.mdDoc }:
+  doRename = { from, to, visible, warn, use, withPriority ? true, markdown ? false }:
     { config, options, ... }:
     let
       fromOpt = getAttrFromPath from options;
@@ -1155,7 +1155,9 @@ rec {
     {
       options = setAttrByPath from (mkOption {
         inherit visible;
-        description = wrapDescription "Alias of {option}`${showOption to}`.";
+        description = if markdown
+          then lib.mdDoc "Alias of {option}`${showOption to}`."
+          else "Alias of <option>${showOption to}</option>.";
         apply = x: use (toOf config);
       } // optionalAttrs (toType != null) {
         type = toType;