From c0c2f2903f310dd5efb86f02b4b5f824183f5173 Mon Sep 17 00:00:00 2001 From: stuebinm Date: Sat, 13 Apr 2024 15:11:11 +0200 Subject: lib.mdDoc: remove and replace with warning --- lib/options.nix | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'lib') diff --git a/lib/options.nix b/lib/options.nix index 0d1d90efe217..a968bb77d4c9 100644 --- a/lib/options.nix +++ b/lib/options.nix @@ -400,9 +400,11 @@ rec { literalExample = lib.warn "lib.literalExample is deprecated, use lib.literalExpression instead, or use lib.literalMD for a non-Nix description." literalExpression; /* Transition marker for documentation that's already migrated to markdown - syntax. This is a no-op and no longer needed. + syntax. Has been a no-op for some while and been removed from nixpkgs. + Kept here to alert downstream users who may not be aware of the migration's + completion that it should be removed from modules. */ - mdDoc = lib.id; + mdDoc = lib.warn "lib.mdDoc was removed from nixpkgs. Option descriptions are now in Markdown by default, you can remove any remaining uses of it."; /* For use in the `defaultText` and `example` option attributes. Causes the given MD text to be inserted verbatim in the documentation, for when -- cgit 1.4.1