From 6a7bd60abbd9d7db2e3d20d41161758aabc3df5a Mon Sep 17 00:00:00 2001 From: Klaus Aehlig Date: Tue, 31 May 2022 18:50:04 +0200 Subject: user-defined rules: describe the TREE function In the defining expression of a rule, the TREE function is also available. Document this. --- doc/concepts/rules.org | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc/concepts') 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 -- cgit v1.2.3