diff options
| author | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-12-08 12:19:33 +0100 |
|---|---|---|
| committer | Oliver Reiche <oliver.reiche@huawei.com> | 2023-12-13 15:23:11 +0100 |
| commit | 94de8e505ca7812e5ae572cdbf75243a7bdc99bf (patch) | |
| tree | 876d4a5afee2a01b7287927e050c949b486a5e7f | |
| parent | c3111850bcf05ee10e08f1203358451ab2af0a4c (diff) | |
| download | justbuild-94de8e505ca7812e5ae572cdbf75243a7bdc99bf.tar.gz | |
Documentation for "configure" rule: clarify role of "config"
... as an overlay for the configuration, not the configuration
to be used for the target to configure.
(cherry picked from commit 76582028a15e265518fad839039ec0efff75383e)
| -rw-r--r-- | doc/concepts/built-in-rules.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/concepts/built-in-rules.md b/doc/concepts/built-in-rules.md index 5591c174..43fd5d2b 100644 --- a/doc/concepts/built-in-rules.md +++ b/doc/concepts/built-in-rules.md @@ -163,10 +163,10 @@ a non-upwards path). The provides map is empty. The `"configure"` rule allows to configure a target with a given configuration. The field `"target"` is evaluated and the result of the evaluation must name a single target (not a list). The `"config"` field -is evaluated and must result in a map, which is used as configuration +is evaluated and must result in a map, which is used as configuration overlay for the given target. -This rule uses the given configuration to overlay the current +This rule uses the given configuration overlay to modify 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 |