From 5ebea52eb790ed787bf71fcb20b08c314a1f4602 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=A9clairevoyant?= <848000+eclairevoyant@users.noreply.github.com> Date: Mon, 15 Apr 2024 09:27:42 -0400 Subject: [PATCH 1/2] lib: add mdDoc back in to provide proper warning --- lib/default.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/default.nix b/lib/default.nix index c77ce88cc..21e4bab2b 100644 --- a/lib/default.nix +++ b/lib/default.nix @@ -146,7 +146,7 @@ let scrubOptionValue literalExpression literalExample showOption showOptionWithDefLocs showFiles unknownModule mkOption mkPackageOption mkPackageOptionMD - literalMD; + mdDoc literalMD; inherit (self.types) isType setType defaultTypeMerge defaultFunctor isOptionType mkOptionType; inherit (self.asserts) From 1e1965bc7b7ea0c310114da244591c0c57db1382 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=A9clairevoyant?= <848000+eclairevoyant@users.noreply.github.com> Date: Mon, 15 Apr 2024 09:33:39 -0400 Subject: [PATCH 2/2] lib: clarify warning about mdDoc --- lib/options.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/options.nix b/lib/options.nix index a968bb77d..7e64e6e51 100644 --- a/lib/options.nix +++ b/lib/options.nix @@ -404,7 +404,7 @@ rec { 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.warn "lib.mdDoc was removed from nixpkgs. Option descriptions are now in Markdown by default, you can remove any remaining uses of it."; + mdDoc = lib.warn "lib.mdDoc will be removed from nixpkgs in 24.11. Option descriptions are now in Markdown by default; you can remove any remaining uses of lib.mdDoc."; /* For use in the `defaultText` and `example` option attributes. Causes the given MD text to be inserted verbatim in the documentation, for when