From: Richard W.M. Jones <rjones@redhat.com>
Date: Sun, 12 Jan 2020 19:34:39 +0000 (+0000)
Subject: docs: Document functions sort, wildcard and wrap.
X-Git-Tag: v'0.2'~29
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=333e7443bbcb0dc07b113d70b9d52cdabfef5ae9;hp=7c0f0662d00ba21743fdb2bc538e89065c0765ad;p=goals.git

docs: Document functions sort, wildcard and wrap.
---

diff --git a/docs/Goalfile.pod b/docs/Goalfile.pod
index d58993e..9731cb1 100644
--- a/docs/Goalfile.pod
+++ b/docs/Goalfile.pod
@@ -14,6 +14,14 @@ Goalfile - introduction, tutorial, and reference for writing goal files
 
 =head2 Standard Functions
 
+=head3 sort (list)
+
+For example:
+
+ sort (["c", "b", "b", "a"]) ⇒ ["a", "b", "c"]
+
+This takes a list of strings and sorts it, removing duplicates.
+
 =head3 subst (from, to, text)
 
 For example:
@@ -25,6 +33,26 @@ This function works something like make’s C<subst> function, except
 that C<from> is a regular expression, specifically a L<sed(1)>
 extended regular expression.
 
+=head3 wildcard (pattern)
+
+For example:
+
+ wildcard ("*.c") ⇒ ["bar.c", "foo.c"]
+
+The single parameter is a wildcard which is expanded into a list of
+files using ordinary globbing rules.
+
+=head3 wrap (wrapper, list)
+
+For example:
+
+ wrap ("*file", ["bar.c", "foo.c"]) ⇒ [*file("bar.c"), *file("foo.c")]
+
+Each element in C<list> is wrapped into a call to C<wrapper(element)>.
+There are two common uses for this: either to add explicit tactics
+(such as C<*file>) to a plain list of strings as in the example above;
+or to turn a list of strings into a list of goal or function calls.
+
 =head1 SEE ALSO
 
 L<goals(1)>.