aboutsummaryrefslogtreecommitdiff
path: root/doc/manual.cli
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2023-09-27 19:34:37 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2023-09-28 10:57:11 +0300
commit9f198ce5192eb4b2026e85666513d1c3fe9add08 (patch)
tree9aeb5679d7bb4b95736033f854a0a0b5087627b8 /doc/manual.cli
parent803059b346f8bccc9b4c4579119a5966b67da993 (diff)
Introduce explicit hidden target configuration class in manual
Diffstat (limited to 'doc/manual.cli')
-rw-r--r--doc/manual.cli19
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/manual.cli b/doc/manual.cli
index 3a00e2d..3a956b7 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -2179,14 +2179,17 @@ to detect warnings in the logs.
The build target configurations can belong to multiple classes with their
names reflecting some common configuration aspects, such as the operating
system, compiler, build options, etc. Predefined class names are \c{default},
-\c{all}, \c{none}, \c{host}, and \c{build2}. The default target configurations
-are built by default. A configuration must also belong to the \c{all} unless
-it is hidden. A configuration that is self-hosted must also belong to the
-\c{host} class and, if it is also self-hosted for build system modules, to the
-\c{build2} class. Valid custom class names must contain only alpha-numeric
-characters, \c{_}, \c{+}, \c{-}, and \c{.}, except as the first character for
-the last three. Class names that start with \c{_} are reserved for the future
-hidden/special class functionality.
+\c{all}, \c{hidden}, \c{none}, \c{host}, and \c{build2}. The default target
+configurations are built by default. A configuration must also belong to the
+\c{all}, \c{hidden}, or some custom-purpose configuration class, intended for
+testing of some optional functionality which a package does not provide by
+default (for example, relocatable installation). A configuration that is
+self-hosted must also belong to the \c{host} class and, if it is also
+self-hosted for build system modules, to the \c{build2} class. Valid custom
+class names must contain only alpha-numeric characters, \c{_}, \c{+}, \c{-},
+and \c{.}, except as the first character for the last three. Class names that
+start with \c{_} are reserved for the future hidden/special class
+functionality.
Regular expressions must start with \c{~}, to be distinguished from target
configuration options and variables. Note that the \c{<tgt-config-arg>} and