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

lib: Fix mismatched quotes in lib.* doc comments

Browse Source 
caused problems for automated rich text generation such as
https://teu5us.github.io/nix-lib.html#customisation-functions
This commit is contained in:
YoshiRulz 2023-01-02 07:51:54 +10:00
parent 942fe7ae60
commit 7fba83890c
No known key found for this signature in database
GPG Key ID: C4DE31C245353FB7
5 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lib/attrsets.nix
View File

@ -88,7 +88,7 @@ rec {
else { ${elemAt attrPath n} = atDepth (n + 1); }; else { ${elemAt attrPath n} = atDepth (n + 1); };
in atDepth 0; in atDepth 0;
/* Like `attrByPath', but without a default value. If it doesn't find the /* Like `attrByPath`, but without a default value. If it doesn't find the
path it will throw an error. path it will throw an error.
Example: Example:
@ -274,7 +274,7 @@ rec {
# The set to get the named attributes from # The set to get the named attributes from
attrs: genAttrs names (name: attrs.${name}); attrs: genAttrs names (name: attrs.${name});
/* Collect each attribute named `attr' from a list of attribute /* Collect each attribute named `attr` from a list of attribute
sets. Sets that don't contain the named attribute are ignored. sets. Sets that don't contain the named attribute are ignored.
Example: Example:
@ -357,8 +357,8 @@ rec {
) {} list_of_attrs; ) {} list_of_attrs;
/* Recursively collect sets that verify a given predicate named `pred' /* Recursively collect sets that verify a given predicate named `pred`
from the set `attrs'. The recursion is stopped when the predicate is from the set `attrs`. The recursion is stopped when the predicate is
verified. verified.
Example: Example:
@ -439,9 +439,9 @@ rec {
listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set))); listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set)));
/* Like `mapAttrs', but allows the name of each attribute to be /* Like `mapAttrs`, but allows the name of each attribute to be
changed in addition to the value. The applied function should changed in addition to the value. The applied function should
return both the new name and value as a `nameValuePair'. return both the new name and value as a `nameValuePair`.
Example: Example:
mapAttrs' (name: value: nameValuePair ("foo_" + name) ("bar-" + value)) mapAttrs' (name: value: nameValuePair ("foo_" + name) ("bar-" + value))
@ -479,7 +479,7 @@ rec {
map (name: f name attrs.${name}) (attrNames attrs); map (name: f name attrs.${name}) (attrNames attrs);
/* Like `mapAttrs', except that it recursively applies itself to /* Like `mapAttrs`, except that it recursively applies itself to
attribute sets. Also, the first argument of the argument attribute sets. Also, the first argument of the argument
function is a *list* of the names of the containing attributes. function is a *list* of the names of the containing attributes.
@ -499,9 +499,9 @@ rec {
mapAttrsRecursiveCond (as: true) f set; mapAttrsRecursiveCond (as: true) f set;
/* Like `mapAttrsRecursive', but it takes an additional predicate /* Like `mapAttrsRecursive`, but it takes an additional predicate
function that tells it whether to recurse into an attribute function that tells it whether to recurse into an attribute
set. If it returns false, `mapAttrsRecursiveCond' does not set. If it returns false, `mapAttrsRecursiveCond` does not
recurse, but does apply the map function. If it returns true, it recurse, but does apply the map function. If it returns true, it
does recurse, and does not apply the map function. does recurse, and does not apply the map function.
@ -655,7 +655,7 @@ rec {
/* Merge sets of attributes and combine each attribute value in to a list. /* Merge sets of attributes and combine each attribute value in to a list.
Like `lib.attrsets.zipAttrsWith' with `(name: values: values)' as the function. Like `lib.attrsets.zipAttrsWith` with `(name: values: values)` as the function.
Example: Example:
zipAttrs [{a = "x";} {a = "y"; b = "z";}] zipAttrs [{a = "x";} {a = "y"; b = "z";}]

22
lib/customisation.nix
View File

@ -3,13 +3,13 @@
rec { rec {
/* `overrideDerivation drv f' takes a derivation (i.e., the result /* `overrideDerivation drv f` takes a derivation (i.e., the result
of a call to the builtin function `derivation') and returns a new of a call to the builtin function `derivation`) and returns a new
derivation in which the attributes of the original are overridden derivation in which the attributes of the original are overridden
according to the function `f'. The function `f' is called with according to the function `f`. The function `f` is called with
the original derivation attributes. the original derivation attributes.
`overrideDerivation' allows certain "ad-hoc" customisation `overrideDerivation` allows certain "ad-hoc" customisation
scenarios (e.g. in ~/.config/nixpkgs/config.nix). For instance, scenarios (e.g. in ~/.config/nixpkgs/config.nix). For instance,
if you want to "patch" the derivation returned by a package if you want to "patch" the derivation returned by a package
function in Nixpkgs to build another version than what the function in Nixpkgs to build another version than what the
@ -104,10 +104,10 @@ rec {
else result; else result;
/* Call the package function in the file `fn' with the required /* Call the package function in the file `fn` with the required
arguments automatically. The function is called with the arguments automatically. The function is called with the
arguments `args', but any missing arguments are obtained from arguments `args`, but any missing arguments are obtained from
`autoArgs'. This function is intended to be partially `autoArgs`. This function is intended to be partially
parameterised, e.g., parameterised, e.g.,
callPackage = callPackageWith pkgs; callPackage = callPackageWith pkgs;
@ -116,9 +116,9 @@ rec {
libbar = callPackage ./bar.nix { }; libbar = callPackage ./bar.nix { };
}; };
If the `libbar' function expects an argument named `libfoo', it is If the `libbar` function expects an argument named `libfoo`, it is
automatically passed as an argument. Overrides or missing automatically passed as an argument. Overrides or missing
arguments can be supplied in `args', e.g. arguments can be supplied in `args`, e.g.
libbar = callPackage ./bar.nix { libbar = callPackage ./bar.nix {
libfoo = null; libfoo = null;
@ -255,13 +255,13 @@ rec {
in lib.deepSeq drv' drv'; in lib.deepSeq drv' drv';
/* Make a set of packages with a common scope. All packages called /* Make a set of packages with a common scope. All packages called
with the provided `callPackage' will be evaluated with the same with the provided `callPackage` will be evaluated with the same
arguments. Any package in the set may depend on any other. The arguments. Any package in the set may depend on any other. The
`overrideScope'` function allows subsequent modification of the package `overrideScope'` function allows subsequent modification of the package
set in a consistent way, i.e. all packages in the set will be set in a consistent way, i.e. all packages in the set will be
called with the overridden packages. The package sets may be called with the overridden packages. The package sets may be
hierarchical: the packages in the set are called with the scope hierarchical: the packages in the set are called with the scope
provided by `newScope' and the set provides a `newScope' attribute provided by `newScope` and the set provides a `newScope` attribute
which can form the parent scope for later package sets. */ which can form the parent scope for later package sets. */
makeScope = newScope: f: makeScope = newScope: f:
let self = f self // { let self = f self // {

2
lib/default.nix
View File

@ -1,7 +1,7 @@
/* Library of low-level helper functions for nix expressions. /* Library of low-level helper functions for nix expressions.
* *
* Please implement (mostly) exhaustive unit tests * Please implement (mostly) exhaustive unit tests
* for new functions in `./tests.nix'. * for new functions in `./tests.nix`.
*/ */
let let

6
lib/lists.nix
View File

@ -242,7 +242,7 @@ rec {
/* Return a singleton list or an empty list, depending on a boolean /* Return a singleton list or an empty list, depending on a boolean
value. Useful when building lists with optional elements value. Useful when building lists with optional elements
(e.g. `++ optional (system == "i686-linux") firefox'). (e.g. `++ optional (system == "i686-linux") firefox`).
Type: optional :: bool -> a -> [a] Type: optional :: bool -> a -> [a]
@ -283,7 +283,7 @@ rec {
*/ */
toList = x: if isList x then x else [x]; toList = x: if isList x then x else [x];
/* Return a list of integers from `first' up to and including `last'. /* Return a list of integers from `first` up to and including `last`.
Type: range :: int -> int -> [int] Type: range :: int -> int -> [int]
@ -320,7 +320,7 @@ rec {
) { right = []; wrong = []; }); ) { right = []; wrong = []; });
/* Splits the elements of a list into many lists, using the return value of a predicate. /* Splits the elements of a list into many lists, using the return value of a predicate.
Predicate should return a string which becomes keys of attrset `groupBy' returns. Predicate should return a string which becomes keys of attrset `groupBy` returns.
`groupBy'` allows to customise the combining function and initial value `groupBy'` allows to customise the combining function and initial value

2
lib/meta.nix
View File

@ -27,7 +27,7 @@ rec {
setName = name: drv: drv // {inherit name;}; setName = name: drv: drv // {inherit name;};
/* Like `setName', but takes the previous name as an argument. /* Like `setName`, but takes the previous name as an argument.
Example: Example:
updateName (oldName: oldName + "-experimental") somePkg updateName (oldName: oldName + "-experimental") somePkg