summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2023-06-11 20:07:13 +0200
committerpennae <github@quasiparticle.net>2023-06-13 16:56:30 +0200
commitc01244394c0b7278c507d6d5de9e4a78db85d1fa (patch)
tree5682c19daa21eda8ac30a356aaa79eea6f039284 /nixos
parent5f35ae16ec0ff4bb71776e3538fde2f561310b64 (diff)
downloadnixpkgs-c01244394c0b7278c507d6d5de9e4a78db85d1fa.tar
nixpkgs-c01244394c0b7278c507d6d5de9e4a78db85d1fa.tar.gz
nixpkgs-c01244394c0b7278c507d6d5de9e4a78db85d1fa.tar.bz2
nixpkgs-c01244394c0b7278c507d6d5de9e4a78db85d1fa.tar.lz
nixpkgs-c01244394c0b7278c507d6d5de9e4a78db85d1fa.tar.xz
nixpkgs-c01244394c0b7278c507d6d5de9e4a78db85d1fa.tar.zst
nixpkgs-c01244394c0b7278c507d6d5de9e4a78db85d1fa.zip
nixos/make-options-doc: force markdownByDefault
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.
Diffstat (limited to 'nixos')
-rw-r--r--nixos/lib/make-options-doc/default.nix7
1 files changed, 4 insertions, 3 deletions
diff --git a/nixos/lib/make-options-doc/default.nix b/nixos/lib/make-options-doc/default.nix
index e4d9a6ebcc7..669bc221ae2 100644
--- a/nixos/lib/make-options-doc/default.nix
+++ b/nixos/lib/make-options-doc/default.nix
@@ -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;