diff options
| author | Oliver Reiche <oliver.reiche@huawei.com> | 2022-09-26 11:02:52 +0200 |
|---|---|---|
| committer | Oliver Reiche <oliver.reiche@huawei.com> | 2022-10-05 15:24:46 +0200 |
| commit | aa29d5ffbdd5f793cdbddbfab6f01840ea937c18 (patch) | |
| tree | 6bccf932c3142aa573f4b57b515b5f31a946f66a | |
| parent | 9557b63094cba0b18bb325c4b880844e85180e47 (diff) | |
| download | justbuild-aa29d5ffbdd5f793cdbddbfab6f01840ea937c18.tar.gz | |
Doc: Describe usage of 'configure' built-in
| -rw-r--r-- | doc/concepts/built-in-rules.org | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/concepts/built-in-rules.org b/doc/concepts/built-in-rules.org index 5d71e673..0da0297f 100644 --- a/doc/concepts/built-in-rules.org +++ b/doc/concepts/built-in-rules.org @@ -122,3 +122,16 @@ Artifacts and runfiles of a ~"file_gen"~ target are a singleton map with key the result of evaluating ~"name"~ and value a (non-executable) file with content the result of evaluating ~"data"~. The provides map is empty. + +** ~"configure"~ + +The ~"configure"~ rule allows to configure a target with a given configuration. +Similar to the ~"export"~ rule, the field ~"target"~ must name a single target +(not a list). The ~"config"~ field is evaluated and must result in a map, which +is used as configuration for the given target. + +This rule uses the given configuration to overlay the current environment for +evaluating the given target, and thereby performs a configuration transition. It +forwards all results (artifacts/runfiles/provides map) of the configured target +to the upper context. The result of a target that uses this rule is the result +of the target given in the ~"target"~ field (the configured target). |