summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorstuebinm <stuebinm@disroot.org>2024-04-13 15:11:11 +0200
committerJonathan Ringer <jonringer@users.noreply.github.com>2024-04-13 10:07:35 -0700
commitc0c2f2903f310dd5efb86f02b4b5f824183f5173 (patch)
treee0cd4123eec4e45da329b36287bb20609360486f
parent46456a929b654ed2ac9c56f8a0c1fa1823a4a2a9 (diff)
lib.mdDoc: remove and replace with warning
-rw-r--r--lib/options.nix6
-rw-r--r--nixos/modules/services/networking/mtr-exporter.nix2
2 files changed, 5 insertions, 3 deletions
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
diff --git a/nixos/modules/services/networking/mtr-exporter.nix b/nixos/modules/services/networking/mtr-exporter.nix
index fa5d6b7d6faa..2b96cb2491ac 100644
--- a/nixos/modules/services/networking/mtr-exporter.nix
+++ b/nixos/modules/services/networking/mtr-exporter.nix
@@ -4,7 +4,7 @@ let
inherit (lib)
maintainers types literalExpression
escapeShellArg escapeShellArgs
- mkEnableOption mkOption mkRemovedOptionModule mkIf
+ mkEnableOption mkOption mkRemovedOptionModule mkIf
mkPackageOption optionalString concatMapStrings concatStringsSep;
cfg = config.services.mtr-exporter;