From: Richard W.M. Jones <rjones@redhat.com>
Date: Tue, 21 Jan 2020 14:22:43 +0000 (+0000)
Subject: docs: Document some shell functions.
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=66e5f712d62a7ac25e647652dbd822a24be1ba93;p=goals.git

docs: Document some shell functions.
---

diff --git a/docs/Goalfile.pod b/docs/Goalfile.pod
index 4c8c3a4..93ca225 100644
--- a/docs/Goalfile.pod
+++ b/docs/Goalfile.pod
@@ -199,6 +199,24 @@ There are two common uses for this: either to add explicit predicates
 (such as C<is-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.
 
+=head2 Standard Shell Functions
+
+=head3 quoted_string
+
+Quote a string which will be consumed as a goal expression.  This is
+typically used from within goal functions which return expressions
+(ie. ones which do I<not> have an explicit C<returning> declaration).
+You must not use this shell function with functions that are marked as
+C<returning string> or C<returning strings>.
+
+=head3 print_green
+
+Echo a string in green.  Useful for success/OK messages.
+
+=head3 print_red
+
+Echo a string in red.  Useful for error messages.
+
 =head1 SEE ALSO
 
 L<goals(1)>.