diff options
| author | Klaus Aehlig <klaus.aehlig@huawei.com> | 2022-05-31 18:50:04 +0200 |
|---|---|---|
| committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2022-06-01 10:43:22 +0200 |
| commit | 6a7bd60abbd9d7db2e3d20d41161758aabc3df5a (patch) | |
| tree | 8c9d95fae3d487341af7bdaaa077a021addbb35f /doc/concepts/rules.org | |
| parent | b70fefba0f15415ebe88bd50d6a2d2606f9afc5e (diff) | |
| download | justbuild-6a7bd60abbd9d7db2e3d20d41161758aabc3df5a.tar.gz | |
user-defined rules: describe the TREE function
In the defining expression of a rule, the TREE function is also
available. Document this.
Diffstat (limited to 'doc/concepts/rules.org')
| -rw-r--r-- | doc/concepts/rules.org | 7 |
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 |