diff options
author | Graham Christensen <graham@grahamc.com> | 2018-10-05 10:46:58 -0400 |
---|---|---|
committer | Graham Christensen <graham@grahamc.com> | 2018-10-05 11:20:46 -0400 |
commit | 5daee73ce41652d21743a7304b4fd3f9da926c35 (patch) | |
tree | 7a799a32287d88d9435855bcdd64437b14efa33a /doc/functions | |
parent | 4312cfdbda1855088905a3d9959a4fac362fd051 (diff) |
Generate links to function definitions
Hydra passes the full revision in to the input, which we pass through.
If we don't get this ,we try to get it from other sources, or default to
master which should have the definition in a close-ish location.
All published docs should have theURL resolve properly, only local
hackers will have the link break.
Diffstat (limited to 'doc/functions')
-rw-r--r-- | doc/functions/library/asserts.xml | 4 | ||||
-rw-r--r-- | doc/functions/library/attrsets.xml | 32 |
2 files changed, 36 insertions, 0 deletions
diff --git a/doc/functions/library/asserts.xml b/doc/functions/library/asserts.xml index 1f42078c8cf3..437850e408bc 100644 --- a/doc/functions/library/asserts.xml +++ b/doc/functions/library/asserts.xml @@ -10,6 +10,8 @@ <subtitle><literal>assertMsg :: Bool -> String -> Bool</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.asserts.assertMsg" /> + <para> Print a trace message if <literal>pred</literal> is false. </para> @@ -59,6 +61,8 @@ stderr> assert failed StringList -> Bool</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.asserts.assertOneOf" /> + <para> Specialized <function>asserts.assertMsg</function> for checking if <varname>val</varname> is one of the elements of <varname>xs</varname>. diff --git a/doc/functions/library/attrsets.xml b/doc/functions/library/attrsets.xml index 7ad3f949a024..6f23e267bab2 100644 --- a/doc/functions/library/attrsets.xml +++ b/doc/functions/library/attrsets.xml @@ -10,6 +10,8 @@ <subtitle><literal>attrByPath :: [String] -> Any -> AttrSet</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.attrByPath" /> + <para> Return an attribute from within nested attribute sets. </para> @@ -73,6 +75,8 @@ lib.attrsets.attrByPath [ "a" "b" ] 0 {} <subtitle><literal>hasAttrByPath :: [String] -> AttrSet -> Bool</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.hasAttrByPath" /> + <para> Determine if an attribute exists within a nested attribute set. </para> @@ -118,6 +122,8 @@ lib.attrsets.hasAttrByPath <subtitle><literal>setAttrByPath :: [String] -> Any -> AttrSet</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.setAttrByPath" /> + <para> Create a new attribute set with <varname>value</varname> set at the nested attribute location specified in <varname>attrPath</varname>. @@ -162,6 +168,8 @@ lib.attrsets.setAttrByPath [ "a" "b" ] 3 <subtitle><literal>getAttrFromPath :: [String] -> AttrSet -> Value</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.getAttrFromPath" /> + <para> Like <xref linkend="function-library-lib.attrsets.attrByPath" /> except without a default, and it will throw if the value doesn't exist. @@ -214,6 +222,8 @@ lib.attrsets.getAttrFromPath [ "x" "y" ] { } <subtitle><literal>attrVals :: [String] -> AttrSet -> [Any]</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.attrVals" /> + <para> Return the specified attributes from a set. All values must exist. </para> @@ -265,6 +275,8 @@ error: attribute 'd' missing <subtitle><literal>attrValues :: AttrSet -> [Any]</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.attrValues" /> + <para> Get all the attribute values from an attribute set. </para> @@ -302,6 +314,8 @@ lib.attrsets.attrValues { a = 1; b = 2; c = 3; } <subtitle><literal>catAttrs :: String -> AttrSet -> [Any]</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.catAttrs" /> + <para> Collect each attribute named `attr' from the list of attribute sets, <varname>sets</varname>. Sets that don't contain the named attribute are @@ -355,6 +369,8 @@ catAttrs "a" [{a = 1;} {b = 0;} {a = 2;}] <subtitle><literal>filterAttrs :: (String -> Any -> Bool) -> AttrSet -> AttrSet</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrs" /> + <para> Filter an attribute set by removing all attributes for which the given predicate return false. @@ -428,6 +444,8 @@ filterAttrs (n: v: n == "foo") { foo = 1; bar = 2; } <subtitle><literal>filterAttrsRecursive :: (String -> Any -> Bool) -> AttrSet -> AttrSet</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrsRecursive" /> + <para> Filter an attribute set recursively by removing all attributes for which the given predicate return false. @@ -523,6 +541,8 @@ lib.attrsets.filterAttrsRecursive <subtitle><literal>foldAttrs :: (Any -> Any -> Any) -> Any -> [AttrSets] -> Any</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.foldAttrs" /> + <para> Apply fold function to values grouped by key. </para> @@ -609,6 +629,8 @@ lib.attrsets.foldAttrs <subtitle><literal>collect :: (Any -> Bool) -> AttrSet -> [Any]</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.collect" /> + <para> Recursively collect sets that verify a given predicate named <varname>pred</varname> from the set <varname>attrs</varname>. The recursion @@ -677,6 +699,8 @@ collect (x: x ? outPath) <subtitle><literal>nameValuePair :: String -> Any -> AttrSet</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.nameValuePair" /> + <para> Utility function that creates a <literal>{name, value}</literal> pair as expected by <function>builtins.listToAttrs</function>. @@ -720,6 +744,8 @@ nameValuePair "some" 6 <subtitle><literal></literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs" /> + <para> Apply a function to each element in an attribute set, creating a new attribute set. @@ -785,6 +811,8 @@ lib.attrsets.mapAttrs <subtitle><literal>mapAttrs' :: (String -> Any -> { name = String; value = Any }) -> AttrSet -> AttrSet</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs-prime" /> + <para> Like <function>mapAttrs</function>, but allows the name of each attribute to be changed in addition to the value. The applied function should return both @@ -860,6 +888,8 @@ lib.attrsets.mapAttrs' (name: value: lib.attrsets.nameValuePair ("foo_" + name) AttrSet -> Any</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsToList" /> + <para> Call <varname>fn</varname> for each attribute in the given <varname>set</varname> and return the result in a list. @@ -929,6 +959,8 @@ lib.attrsets.mapAttrsToList (name: value: "${name}=${value}") <subtitle><literal>mapAttrsRecursive :: ([String] > Any -> Any) -> AttrSet -> AttrSet</literal> </subtitle> + <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursive" /> + <para> Like <function>mapAttrs</function>, except that it recursively applies itself to attribute sets. Also, the first argument of the argument function |