alioth/nixpkgs
3
0
Fork 0
forked from mirrors/nixpkgs
Code Releases Activity

nixos/make-options-doc: force markdownByDefault

Browse source 
with docbook no longer supported we can default to markdown option docs.
we'll keep the parameter around for a bit to not break external users
who set it to true. we don't know of any users that do, so the
deprecation period may be rather short for this one.
This commit is contained in:
pennae 2023-06-11 20:07:13 +02:00
parent 5f35ae16ec
commit c01244394c
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
nixos/lib/make-options-doc/default.nix
View file

@ -43,11 +43,12 @@
# TODO remove in a while.
, allowDocBook ? false
# 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
# deprecated since 23.11.
# TODO remove in a while.
, markdownByDefault ? true
}:
assert ! allowDocBook;
assert markdownByDefault && ! allowDocBook;
let
rawOpts = lib.optionAttrSetToDocList options;