summaryrefslogtreecommitdiff
path: root/doc/concepts/rules.org
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2022-05-09 17:10:42 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2022-05-10 15:45:29 +0200
commit534f233ce9ca50aa05d16b465e42079bec7edb60 (patch)
treeb5dc3f971641f030041c9f892a5fd9c7857f3298 /doc/concepts/rules.org
parent77575870a0ce63abd8b87ff64080075a554daf93 (diff)
downloadjustbuild-534f233ce9ca50aa05d16b465e42079bec7edb60.tar.gz
Document built-in rules
Diffstat (limited to 'doc/concepts/rules.org')
-rw-r--r--doc/concepts/rules.org8
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/concepts/rules.org b/doc/concepts/rules.org
index f5cfdd8c..a8837ae9 100644
--- a/doc/concepts/rules.org
+++ b/doc/concepts/rules.org
@@ -1,4 +1,4 @@
-* Rules
+* User-defined Rules
Targets are defined in terms of high-level concepts like "libraries",
"binaries", etc. In order to translate these high-level definitions
@@ -9,7 +9,11 @@ single point how all targets of a given type are built.
Rules are defined in rules files (by default named ~RULES~). Those
contain a JSON object mapping rule names to their rule definition.
-For rules, the same naming scheme as for targets applies.
+For rules, the same naming scheme as for targets applies. However,
+built-in rules (always named by a single string) take precedence
+in naming; to explicitly refer to a rule defined in the current
+module, the module has to be specified, possibly by a relative
+path, e.g., ~["./", ".", "install"]~.
** Basic components of a rule