summary refs log tree commit diff
path: root/lib
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-09-01 19:23:59 +0200
committerpennae <82953136+pennae@users.noreply.github.com>2022-09-10 18:23:13 +0200
commit767485a0dee24329e2b34cd4af0c08ea21e959ea (patch)
tree13a42cff4608334fcd9f6f21e5a5758020782d7b /lib
parent8c309aa43ae9e5e4dbdd542e4e5e49253d3dd763 (diff)
lib/options: deprecate docbook text and literalDocBook
deprecate literalDocBook by adding a warning (that will not fire yet) to
its uses and other docbook literal strings by adding optional warning
message to mergeJSON.
Diffstat (limited to 'lib')
-rw-r--r--lib/options.nix5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/options.nix b/lib/options.nix
index a56e579ab84da..dea85f0db04cb 100644
--- a/lib/options.nix
+++ b/lib/options.nix
@@ -284,7 +284,10 @@ rec {
   */
   literalDocBook = text:
     if ! isString text then throw "literalDocBook expects a string."
-    else { _type = "literalDocBook"; inherit text; };
+    else
+      lib.warnIf (lib.isInOldestRelease 2211)
+        "literalDocBook is deprecated, use literalMD instead"
+        { _type = "literalDocBook"; inherit text; };
 
   /* Transition marker for documentation that's already migrated to markdown
      syntax.