swendel/nixpkgs
1
0
Fork 0
mirror of https://github.com/SebastianWendel/nixpkgs.git synced 2024-09-20 04:19:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

lib/options: add literalExpression and literalDocBook, deprecate literalExample

Browse source
This commit is contained in:
Naïm Favier 2021-10-03 17:19:19 +02:00
parent c3bf08d1b0
commit 52a2e4136e
No known key found for this signature in database
GPG key ID: 49B07322580B7EE2
2 changed files with 21 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/default.nix
View file

@ -123,8 +123,8 @@ let
inherit (self.options) isOption mkEnableOption mkSinkUndeclaredOptions inherit (self.options) isOption mkEnableOption mkSinkUndeclaredOptions
mergeDefaultOption mergeOneOption mergeEqualOption getValues mergeDefaultOption mergeOneOption mergeEqualOption getValues
getFiles optionAttrSetToDocList optionAttrSetToDocList' getFiles optionAttrSetToDocList optionAttrSetToDocList'
scrubOptionValue literalExample showOption showFiles scrubOptionValue literalExpression literalExample literalDocBook
unknownModule mkOption; showOption showFiles unknownModule mkOption;
inherit (self.types) isType setType defaultTypeMerge defaultFunctor inherit (self.types) isType setType defaultTypeMerge defaultFunctor
isOptionType mkOptionType; isOptionType mkOptionType;
inherit (self.asserts) inherit (self.asserts)

24
lib/options.nix
View file

@ -54,7 +54,7 @@ rec {
Example: Example:
mkOption { } // => { _type = "option"; } mkOption { } // => { _type = "option"; }
mkOption { defaultText = "foo"; } // => { _type = "option"; defaultText = "foo"; } mkOption { default = "foo"; } // => { _type = "option"; default = "foo"; }
*/ */
mkOption = mkOption =
{ {
@ -212,11 +212,25 @@ rec {
else x; else x;
/* For use in the `example` option attribute. It causes the given /* For use in the `defaultText` and `example` option attributes. Causes the
text to be included verbatim in documentation. This is necessary given string to be rendered verbatim in the documentation as Nix code. This
for example values that are not simple values, e.g., functions. is necessary for complex values, e.g. functions, or values that depend on
other values or packages.
*/ */
literalExample = text: { _type = "literalExample"; inherit text; }; literalExpression = text:
if ! isString text then throw "literalExpression expects a string."
else { _type = "literalExpression"; inherit text; };
literalExample = lib.warn "literalExample is deprecated, use literalExpression instead, or use literalDocBook for a non-Nix description." literalExpression;
/* For use in the `defaultText` and `example` option attributes. Causes the
given DocBook text to be inserted verbatim in the documentation, for when
a `literalExpression` would be too hard to read.
*/
literalDocBook = text:
if ! isString text then throw "literalDocBook expects a string."
else { _type = "literalDocBook"; inherit text; };
# Helper functions. # Helper functions.