summaryrefslogtreecommitdiff
path: root/doc/concepts
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2024-06-25 11:11:17 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2024-06-25 15:57:29 +0200
commit23b54f3f6401d5b52bd903485985ad38e0c3fba7 (patch)
tree07dcc9c98e95f7cd603a8f50842221ad6df677d7 /doc/concepts
parent165d9ba942171ab3436c834c83184abf38b11bec (diff)
downloadjustbuild-23b54f3f6401d5b52bd903485985ad38e0c3fba7.tar.gz
describe: also describe "configure" targets in more detail
Most built-in rules are just described by their name, assuming they are known to the user anyway. One exception, however, are "export" targets, as those serve as interfaces to (logical) repositories and hence is supposed to have a documentation of the target itself. Over time, however, "configure" targets have evolved to become internal interfaces (maybe even for an external target), e.g., to provide default values and hence make better use of the actual export target. Therefore it is desirable to provide a bit more information when asked to describe a "configure" target. - As "configure" targets have a fixed set of keys, adding a "doc" field is a conservative extension; this can be useful to give an overview what the target is about. - An important information of a "configure" target is the target that is configured. While this, in general, is an expression, in the typical cases, the description is very short (a literal target name, or a variable). So we can afford to show the definition.
Diffstat (limited to 'doc/concepts')
-rw-r--r--doc/concepts/doc-strings.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/concepts/doc-strings.md b/doc/concepts/doc-strings.md
index ed4ee84b..22115cee 100644
--- a/doc/concepts/doc-strings.md
+++ b/doc/concepts/doc-strings.md
@@ -131,6 +131,16 @@ strings describing the targeted in general and `"config_doc"` is a map
from (some of) the variables of the `"flexible_config"` to an array of
strings describing this parameter.
+Configure targets
+-----------------
+
+As configure targets often serve as internal interface to external
+export targets (e.g., in order to set a needed configuration), we
+support documentation here as well. As configure targets, being
+built-in, have a fixed set of fields, a `"doc"` field can be used
+for this purpose without conflicts. Again, the `"doc"` field is an
+array of strings describing the target in general.
+
Presentation of the documentation
---------------------------------