diff options
| author | stuebinm <stuebinm@disroot.org> | 2024-04-13 15:11:11 +0200 |
|---|---|---|
| committer | Jonathan Ringer <jonringer@users.noreply.github.com> | 2024-04-13 10:07:35 -0700 |
| commit | c0c2f2903f310dd5efb86f02b4b5f824183f5173 (patch) | |
| tree | e0cd4123eec4e45da329b36287bb20609360486f /lib | |
| parent | 46456a929b654ed2ac9c56f8a0c1fa1823a4a2a9 (diff) | |
lib.mdDoc: remove and replace with warning
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/options.nix | 6 |
1 files changed, 4 insertions, 2 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 |