summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/concepts/rules.org7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/concepts/rules.org b/doc/concepts/rules.org
index a8837ae9..e91b2ecd 100644
--- a/doc/concepts/rules.org
+++ b/doc/concepts/rules.org
@@ -140,6 +140,13 @@ which is optional and defaults to the empty string. This argument
has to evaluate to a string. The function returns an artifact that
is a non-executable file with the given string as content.
+**** ~TREE~
+
+The ~TREE~ function takes a single (evaluated) argument ~$1~ which
+has to be a map of artifacts. The result is a single tree artifact
+formed from the input map. It is an error if the map cannot be
+transformed into a tree (e.g., due to staging conflicts).
+
**** ~ACTION~
Actions are a way to define new artifacts from (zero or more) already