Git commit d974610efba6140798b10d13d092558e9226f796 by Andrew Shark.
Committed on 29/01/2024 at 21:21.
Pushed by ashark into branch 'master'.
doc: Define scopes for modules selection options
M +16 -16 doc/conf-options-table.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/d974610efba6140798b10d13d092558e9226f796
diff --git a/doc/conf-options-table.docbook b/doc/conf-options-table.docbook
index 345ef74e..b35d520c 100644
--- a/doc/conf-options-table.docbook
+++ b/doc/conf-options-table.docbook
@@ -1,17 +1,16 @@
Table of available configuration options
-Here is a table of the various options, containing the following
+Here are tables of various options, containing the following
information:
The option name
-A description of how responds if the option is
-set in both the global section, and the module section of the configuration file while building a
-module.
+The scope of the option: global,
module or module-set.
+Options in module or/and module-set
scope can also be defined in options sections.
+
Special comments on the purpose and usage of the
option.
@@ -1316,7 +1315,7 @@ installations. However this only works on build systems
that support
no-src
-globalmodulemodule-setoptions
+globalmodulemodule-set
Remove update phase. The other phases that were
presented will still be processed.
Related command-line option:
@@ -1325,7 +1324,7 @@ installations. However this only works on build systems
that support
no-install
-globalmodulemodule-setoptions
+globalmodulemodule-set
Remove install phase. The other phases that were
presented will still be processed.
Related command-line option:
@@ -1334,7 +1333,7 @@ installations. However this only works on build systems
that support
no-tests
-globalmodulemodule-setoptions
+globalmodulemodule-set
Remove test phase. The other phases that were
presented will still be processed.
Related command-line option: --no-tests
@@ -1343,7 +1342,7 @@ installations. However this only works on build systems
that support
no-build
-globalmodulemodule-setoptions
+globalmodulemodule-set
Remove build phase. The other phases that were
presented will still be processed.
Related command-line option:
@@ -1352,7 +1351,7 @@ installations. However this only works on build systems
that support
build-only
-globalmodulemodule-setoptions
+globalmodulemodule-set
If had build phase, remove any other phases.
Otherwise, remove all phases.
Related command-line option:
@@ -1361,7 +1360,7 @@ installations. However this only works on build systems
that support
install-only
-globalmodulemodule-setoptions
+globalmodulemodule-set
If had install phase, remove any other phases.
Otherwise, remove all phases.
Related command-line option:
@@ -1370,7 +1369,7 @@ installations. However this only works on build systems
that support
uninstall
-globalmodulemodule-setoptions
+globalmodulemodule-set
If had uninstall phase, remove any other phases.
Otherwise, remove all phases.
Related command-line option: --uninstall
@@ -1379,7 +1378,7 @@ installations. However this only works on build systems
that support
filter-out-phases
-globalmodulemodule-setoptions
+globalmodulemodule-set
Remove those phases that are listed (space separated) in this option.
The other phases that were presented will still be processed.
@@ -1390,12 +1389,13 @@ installations. However this only works on build systems
that support
-Module-set and global scope options
+Modules selection options
Option name
+Scope
Description
@@ -1404,12 +1404,12 @@ installations. However this only works on build systems
that support
ignore-modules
+globalmodule-set
TypeString
Available since1.16
-This option can be used in global section and in module-sets.
Note that when specified in global section, cmdline
option does not override this, but instead appends.
Modules named by this option, which would be chosen by
due to a use-modules option, are
@@ -1436,12 +1436,12 @@ is compared).
use-modules
+module-set
TypeString
Available since1.12.1
-Can only be used in module-set.
This option allows you to easily
specify many different modules to build at the same point in the configuration file.
