dev/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

lib/options: remove mdDoc

Browse Source 
Following through on message itself.
This commit is contained in:
Wolfgang Walther 2024-11-17 11:05:34 +01:00
parent 14ac480f28
commit 73df63f8ef
No known key found for this signature in database
GPG Key ID: B39893FA5F65CAE1
3 changed files with 1 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/default.nix
View File

@ -152,7 +152,7 @@ let
scrubOptionValue literalExpression literalExample scrubOptionValue literalExpression literalExample
showOption showOptionWithDefLocs showFiles showOption showOptionWithDefLocs showFiles
unknownModule mkOption mkPackageOption mkPackageOptionMD unknownModule mkOption mkPackageOption mkPackageOptionMD
mdDoc literalMD; literalMD;
inherit (self.types) isType setType defaultTypeMerge defaultFunctor inherit (self.types) isType setType defaultTypeMerge defaultFunctor
isOptionType mkOptionType; isOptionType mkOptionType;
inherit (self.asserts) inherit (self.asserts)

7
lib/options.nix
View File

@ -399,13 +399,6 @@ rec {
literalExample = lib.warn "lib.literalExample is deprecated, use lib.literalExpression instead, or use lib.literalMD for a non-Nix description." literalExpression; 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. 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.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 /* For use in the `defaultText` and `example` option attributes. Causes the
given MD text to be inserted verbatim in the documentation, for when given MD text to be inserted verbatim in the documentation, for when
a `literalExpression` would be too hard to read. a `literalExpression` would be too hard to read.

10
nixos/lib/make-options-doc/default.nix
View File

@ -111,18 +111,8 @@
# instead of printing warnings for eg options with missing descriptions (which may be lost # instead of printing warnings for eg options with missing descriptions (which may be lost
# by nix build unless -L is given), emit errors instead and fail the build # by nix build unless -L is given), emit errors instead and fail the build
, warningsAreErrors ? true , warningsAreErrors ? true
# allow docbook option docs if `true`. only markdown documentation is allowed when set to
# `false`, and a different renderer may be used with different bugs and performance
# characteristics but (hopefully) indistinguishable output.
# deprecated since 23.11.
# TODO remove in a while.
, allowDocBook ? false
# TODO remove in a while (see https://github.com/NixOS/nixpkgs/issues/300735)
, markdownByDefault ? true
}: }:
assert markdownByDefault && ! allowDocBook;
let let
rawOpts = lib.optionAttrSetToDocList options; rawOpts = lib.optionAttrSetToDocList options;
transformedOpts = map transformOptions rawOpts; transformedOpts = map transformOptions rawOpts;