diff options
author | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-12-08 12:19:33 +0100 |
---|---|---|
committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-12-11 15:20:13 +0100 |
commit | 76582028a15e265518fad839039ec0efff75383e (patch) | |
tree | 05c7b661f8b8025493cb31f1aaa20a7ef32505c7 /doc/concepts/built-in-rules.md | |
parent | 3eef9b3da3529b60fc3fd68930023dd1a0e6f50c (diff) | |
download | justbuild-76582028a15e265518fad839039ec0efff75383e.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.
Diffstat (limited to 'doc/concepts/built-in-rules.md')
-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 fc644a03..69df06dc 100644 --- a/doc/concepts/built-in-rules.md +++ b/doc/concepts/built-in-rules.md @@ -166,10 +166,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 |