From dd576b8730b1aa9ea90fba20367471b4a09da5d3 Mon Sep 17 00:00:00 2001 From: Paul Cristian Sarbu Date: Thu, 10 Aug 2023 12:03:33 +0200 Subject: doc: Extend documentation with 'symlink' built-in rule --- doc/concepts/built-in-rules.md | 17 +++++++++++++++++ 1 file changed, 17 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 319d0d82..5591c174 100644 --- a/doc/concepts/built-in-rules.md +++ b/doc/concepts/built-in-rules.md @@ -140,6 +140,23 @@ 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. +`"symlink"` +------------ + +The `"symlink"` rule allows to specify a non-upwards symbolic link with a +given link target. To be able to accurately report about file names of +artifacts or runfiles of other targets, they can be specified in the field +`"deps"` which has to evaluate to a list of targets. The names of the +artifacts and runfiles of a target specified in `"deps"` can be accessed +through the functions `"outs"` and `"runfiles"`, respectively, during the +evaluation of the arguments `"name"` and `"data"` which have to evaluate to +a single string. + +Artifacts and runfiles of a `"symlink"` target are a singleton map with +key the result of evaluating `"name"` and value a non-upwards symbolic link +with target path the result of evaluating `"data"` (which must evaluate to +a non-upwards path). The provides map is empty. + `"configure"` ------------- -- cgit v1.2.3