summary refs log tree commit diff
path: root/nixos/modules/misc
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2023-06-11 19:29:32 +0200
committerpennae <github@quasiparticle.net>2023-06-13 16:56:30 +0200
commit0997ae1903b0f18cd9e43e4a65ffdd8f1e1ff285 (patch)
tree0239331544240803f0566bd54b5b58a9758db9da /nixos/modules/misc
parent96ce8d59649f20c21b01f146bcd6b37aa14cd59e (diff)
downloadnixpkgs-0997ae1903b0f18cd9e43e4a65ffdd8f1e1ff285.tar
nixpkgs-0997ae1903b0f18cd9e43e4a65ffdd8f1e1ff285.tar.gz
nixpkgs-0997ae1903b0f18cd9e43e4a65ffdd8f1e1ff285.tar.bz2
nixpkgs-0997ae1903b0f18cd9e43e4a65ffdd8f1e1ff285.tar.lz
nixpkgs-0997ae1903b0f18cd9e43e4a65ffdd8f1e1ff285.tar.xz
nixpkgs-0997ae1903b0f18cd9e43e4a65ffdd8f1e1ff285.tar.zst
nixpkgs-0997ae1903b0f18cd9e43e4a65ffdd8f1e1ff285.zip
nixos/manual: disallow docbook option docs
it's been long in the making, and with 23.05 out we can finally disable
docbook option docs and default to markdown instead. this brings a
massive speed boost in manual and manpage builds, so much so that we may
consider enabling user module documentation by default.

we don't remove the docbook support code entirely yet because it's a lot
all over, and probably better removed in multiple separate changes.
Diffstat (limited to 'nixos/modules/misc')
-rw-r--r--nixos/modules/misc/documentation.nix22
1 files changed, 4 insertions, 18 deletions
diff --git a/nixos/modules/misc/documentation.nix b/nixos/modules/misc/documentation.nix
index 31486a2216a..e6a56a8cdf2 100644
--- a/nixos/modules/misc/documentation.nix
+++ b/nixos/modules/misc/documentation.nix
@@ -107,7 +107,7 @@ let
             } >&2
         '';
 
-    inherit (cfg.nixos.options) warningsAreErrors allowDocBook;
+    inherit (cfg.nixos.options) warningsAreErrors;
   };
 
 
@@ -160,6 +160,9 @@ in
     (mkRenamedOptionModule [ "programs" "info" "enable" ] [ "documentation" "info" "enable" ])
     (mkRenamedOptionModule [ "programs" "man"  "enable" ] [ "documentation" "man"  "enable" ])
     (mkRenamedOptionModule [ "services" "nixosManual" "enable" ] [ "documentation" "nixos" "enable" ])
+    (mkRemovedOptionModule
+      [ "documentation" "nixos" "options" "allowDocBook" ]
+      "DocBook option documentation is no longer supported")
   ];
 
   options = {
@@ -264,23 +267,6 @@ in
         '';
       };
 
-      nixos.options.allowDocBook = mkOption {
-        type = types.bool;
-        default = true;
-        description = lib.mdDoc ''
-          Whether to allow DocBook option docs. When set to `false` all option using
-          DocBook documentation will cause a manual build error; additionally a new
-          renderer may be used.
-
-          ::: {.note}
-          The `false` setting for this option is not yet fully supported. While it
-          should work fine and produce the same output as the previous toolchain
-          using DocBook it may not work in all circumstances. Whether markdown option
-          documentation is allowed is independent of this option.
-          :::
-        '';
-      };
-
       nixos.options.warningsAreErrors = mkOption {
         type = types.bool;
         default = true;