From f5a4fb313e0c4ee5841a699186e4767ad67f407c Mon Sep 17 00:00:00 2001 From: Klaus Aehlig Date: Thu, 27 Mar 2025 16:53:04 +0100 Subject: Documentation of built-in rules: document {disjoint_,}tree_overlay --- doc/concepts/built-in-rules.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc/concepts/built-in-rules.md') diff --git a/doc/concepts/built-in-rules.md b/doc/concepts/built-in-rules.md index e7a5e2e3..5c502668 100644 --- a/doc/concepts/built-in-rules.md +++ b/doc/concepts/built-in-rules.md @@ -148,6 +148,20 @@ of the `"tree"` target are a singleton map with the key the result of evaluating `"name"` (which has to evaluate to a single string) and value that tree. +`"tree_overlay"` and `"disjoint_tree_overlay"` +---------------------------------------------- + +The rules `"tree_overlay"` and `"disjoint_tree_overlay"` allow to +define a tree as the overlay of the trees given by the artifact +stages of a list of given targets. More precisely, the field `"deps"` +has to evaluate to a list of targets. For each target, a tree is +formed from its artifact stage. A new tree is defined as the tree +overlay, or disjoint tree overlay, of those trees. Both, artifacts +and runfiles of the target are a singleton map with key the result +of evaluating the field `"name"` which has to evaluate to a single +string and value that (disjoint) tree overlay. + + `"symlink"` ------------ -- cgit v1.2.3