diff options
| author | Jan Tojnar <jtojnar@gmail.com> | 2020-03-04 21:24:05 +0100 |
|---|---|---|
| committer | Jan Tojnar <jtojnar@gmail.com> | 2020-03-04 21:24:05 +0100 |
| commit | 1a44e325d2b4d9d487f469e7f0ca2af73c8b270d (patch) | |
| tree | 1ca842b9db5b4f2f94965bf9dd670ec151049f3c /doc | |
| parent | 62e09735d04b4593e0542ad884850acc1236261f (diff) | |
| parent | 7399c59c4150635b896470078c5f5d18d702061a (diff) | |
| download | nixlib-1a44e325d2b4d9d487f469e7f0ca2af73c8b270d.tar nixlib-1a44e325d2b4d9d487f469e7f0ca2af73c8b270d.tar.gz nixlib-1a44e325d2b4d9d487f469e7f0ca2af73c8b270d.tar.bz2 nixlib-1a44e325d2b4d9d487f469e7f0ca2af73c8b270d.tar.lz nixlib-1a44e325d2b4d9d487f469e7f0ca2af73c8b270d.tar.xz nixlib-1a44e325d2b4d9d487f469e7f0ca2af73c8b270d.tar.zst nixlib-1a44e325d2b4d9d487f469e7f0ca2af73c8b270d.zip | |
Merge branch 'staging-next' into staging
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 4 | ||||
| -rw-r--r-- | doc/functions/library/attrsets.xml | 44 |
2 files changed, 46 insertions, 2 deletions
diff --git a/doc/Makefile b/doc/Makefile index e7ca31b20d71..cdef493502bf 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -87,7 +87,7 @@ functions/library/generated: doc-support/result ln -rfs ./doc-support/result/function-docs functions/library/generated %.section.xml: %.section.md - pandoc $^ -w docbook+smart \ + pandoc $^ -w docbook \ -f markdown+smart \ | sed -e 's|<ulink url=|<link xlink:href=|' \ -e 's|</ulink>|</link>|' \ @@ -98,7 +98,7 @@ functions/library/generated: doc-support/result | cat > $@ %.chapter.xml: %.chapter.md - pandoc $^ -w docbook+smart \ + pandoc $^ -w docbook \ --top-level-division=chapter \ -f markdown+smart \ | sed -e 's|<ulink url=|<link xlink:href=|' \ diff --git a/doc/functions/library/attrsets.xml b/doc/functions/library/attrsets.xml index b1ea05a2381d..3c5823c25891 100644 --- a/doc/functions/library/attrsets.xml +++ b/doc/functions/library/attrsets.xml @@ -1667,4 +1667,48 @@ recursiveUpdate ]]></programlisting> </example> </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> |