Document attrsets.recurseIntoAttrs
This commit is contained in:
parent
fc64cf65ab
commit
a96f37db10
@ -1728,4 +1728,48 @@ recursiveUpdate
|
|||||||
]]></programlisting>
|
]]></programlisting>
|
||||||
</example>
|
</example>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section xml:id="function-library-lib.attrsets.recurseIntoAttrs">
|
||||||
|
<title><function>lib.attrsets.recurseIntoAttrs</function></title>
|
||||||
|
|
||||||
|
<subtitle><literal>recurseIntoAttrs :: AttrSet -> AttrSet</literal>
|
||||||
|
</subtitle>
|
||||||
|
|
||||||
|
<xi:include href="./locations.xml" xpointer="lib.attrsets.recurseIntoAttrs" />
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Make various Nix tools consider the contents of the resulting
|
||||||
|
attribute set when looking for what to build, find, etc.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
This function only affects a single attribute set; it does not apply itself recursively for nested attribute sets.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<varname>attrs</varname>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
An attribute set to scan for derivations.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
|
||||||
|
<example xml:id="function-library-lib.attrsets.recurseIntoAttrs-example">
|
||||||
|
<title>Making Nix look inside an attribute set</title>
|
||||||
|
<programlisting><![CDATA[
|
||||||
|
{ pkgs ? import <nixpkgs> {} }:
|
||||||
|
{
|
||||||
|
myTools = pkgs.lib.recurseIntoAttrs {
|
||||||
|
inherit (pkgs) hello figlet;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
]]></programlisting>
|
||||||
|
</example>
|
||||||
|
</section>
|
||||||
|
|
||||||
</section>
|
</section>
|
||||||
|
@ -475,6 +475,9 @@ rec {
|
|||||||
|
|
||||||
/* Make various Nix tools consider the contents of the resulting
|
/* Make various Nix tools consider the contents of the resulting
|
||||||
attribute set when looking for what to build, find, etc.
|
attribute set when looking for what to build, find, etc.
|
||||||
|
|
||||||
|
This function only affects a single attribute set; it does not
|
||||||
|
apply itself recursively for nested attribute sets.
|
||||||
*/
|
*/
|
||||||
recurseIntoAttrs =
|
recurseIntoAttrs =
|
||||||
attrs: attrs // { recurseForDerivations = true; };
|
attrs: attrs // { recurseForDerivations = true; };
|
||||||
|
@ -62,8 +62,6 @@ in
|
|||||||
|
|
||||||
inherit (lib) lowPrio hiPrio appendToName makeOverridable;
|
inherit (lib) lowPrio hiPrio appendToName makeOverridable;
|
||||||
|
|
||||||
# Make various Nix tools consider the contents of the resulting
|
|
||||||
# attribute set when looking for what to build, find, etc.
|
|
||||||
inherit (lib) recurseIntoAttrs;
|
inherit (lib) recurseIntoAttrs;
|
||||||
|
|
||||||
# This is intended to be the reverse of recurseIntoAttrs, as it is
|
# This is intended to be the reverse of recurseIntoAttrs, as it is
|
||||||
|
Loading…
Reference in New Issue
Block a user