diff options
| author | Naïm Favier <n@monade.li> | 2023-01-08 22:41:13 +0100 |
|---|---|---|
| committer | github-actions[bot] <github-actions[bot]@users.noreply.github.com> | 2023-01-09 10:36:26 +0000 |
| commit | 587a27bad59cb67449229c1845418eb606900f60 (patch) | |
| tree | 51042b903b359ec323924ee64d5beccd59d924f1 | |
| parent | b4cf26ea172c8a02f6757b347e40641dd9854c98 (diff) | |
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.
(cherry picked from commit fb1bc8de93d3c2dba328224a082ecf1ad2fc7fac)
| -rw-r--r-- | lib/modules.nix | 8 | ||||
| -rw-r--r-- | nixos/lib/make-options-doc/default.nix | 1 |
2 files changed, 6 insertions, 3 deletions
diff --git a/lib/modules.nix b/lib/modules.nix index cea34b0d8436..0a9fd74ce824 100644 --- a/lib/modules.nix +++ b/lib/modules.nix @@ -1112,7 +1112,6 @@ rec { visible = true; warn = false; use = id; - wrapDescription = lib.id; }; /* Transitional version of mkAliasOptionModule that uses MD docs. */ @@ -1121,6 +1120,7 @@ rec { visible = true; warn = false; use = id; + markdown = true; }; /* mkDerivedConfig : Option a -> (a -> Definition b) -> Definition b @@ -1143,7 +1143,7 @@ rec { (opt.highestPrio or defaultPriority) (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; @@ -1154,7 +1154,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; diff --git a/nixos/lib/make-options-doc/default.nix b/nixos/lib/make-options-doc/default.nix index e097aa5eebd8..f78d1038b63a 100644 --- a/nixos/lib/make-options-doc/default.nix +++ b/nixos/lib/make-options-doc/default.nix @@ -41,6 +41,7 @@ # characteristics but (hopefully) indistinguishable output. , allowDocBook ? true # whether lib.mdDoc is required for descriptions to be read as markdown. +# !!! when this is eventually flipped to true, `lib.doRename` should also default to emitting Markdown , markdownByDefault ? false }: |