summary refs log tree commit diff
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2023-06-11 19:51:46 +0200
committerpennae <github@quasiparticle.net>2023-06-13 16:56:30 +0200
commit7542a1aa8fde98d8ff2792f852af19a8bc798842 (patch)
tree79b217d4090a595aa07c21b20067915769909a5e
parent0997ae1903b0f18cd9e43e4a65ffdd8f1e1ff285 (diff)
downloadnixpkgs-7542a1aa8fde98d8ff2792f852af19a8bc798842.tar
nixpkgs-7542a1aa8fde98d8ff2792f852af19a8bc798842.tar.gz
nixpkgs-7542a1aa8fde98d8ff2792f852af19a8bc798842.tar.bz2
nixpkgs-7542a1aa8fde98d8ff2792f852af19a8bc798842.tar.lz
nixpkgs-7542a1aa8fde98d8ff2792f852af19a8bc798842.tar.xz
nixpkgs-7542a1aa8fde98d8ff2792f852af19a8bc798842.tar.zst
nixpkgs-7542a1aa8fde98d8ff2792f852af19a8bc798842.zip
lib/options: remove literalDocBook
no longer supported. warning when used would not be appropriate, and
docbook has been on the way out for long enough that throwing an error
should not be necessary either.
-rw-r--r--lib/default.nix2
-rw-r--r--lib/options.nix14
2 files changed, 2 insertions, 14 deletions
diff --git a/lib/default.nix b/lib/default.nix
index 8fea4b8ad63..73b8ad87154 100644
--- a/lib/default.nix
+++ b/lib/default.nix
@@ -138,7 +138,7 @@ let
       mergeDefaultOption mergeOneOption mergeEqualOption mergeUniqueOption
       getValues getFiles
       optionAttrSetToDocList optionAttrSetToDocList'
-      scrubOptionValue literalExpression literalExample literalDocBook
+      scrubOptionValue literalExpression literalExample
       showOption showOptionWithDefLocs showFiles
       unknownModule mkOption mkPackageOption mkPackageOptionMD
       mdDoc literalMD;
diff --git a/lib/options.nix b/lib/options.nix
index af7914bb513..11a3984aa47 100644
--- a/lib/options.nix
+++ b/lib/options.nix
@@ -344,19 +344,7 @@ rec {
     if ! isString text then throw "literalExpression expects a string."
     else { _type = "literalExpression"; inherit text; };
 
-  literalExample = lib.warn "literalExample is deprecated, use literalExpression instead, or use literalDocBook for a non-Nix description." literalExpression;
-
-
-  /* For use in the `defaultText` and `example` option attributes. Causes the
-     given DocBook text to be inserted verbatim in the documentation, for when
-     a `literalExpression` would be too hard to read.
-  */
-  literalDocBook = text:
-    if ! isString text then throw "literalDocBook expects a string."
-    else
-      lib.warnIf (lib.isInOldestRelease 2211)
-        "literalDocBook is deprecated, use literalMD instead"
-        { _type = "literalDocBook"; inherit text; };
+  literalExample = lib.warn "literalExample is deprecated, use literalExpression instead, or use literalMD for a non-Nix description." literalExpression;
 
   /* Transition marker for documentation that's already migrated to markdown
      syntax.