From 767485a0dee24329e2b34cd4af0c08ea21e959ea Mon Sep 17 00:00:00 2001
From: pennae <github@quasiparticle.net>
Date: Thu, 1 Sep 2022 19:23:59 +0200
Subject: 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.
---
 lib/options.nix | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/options.nix b/lib/options.nix
index a56e579ab84d..dea85f0db04c 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.
-- 
cgit v1.2.3