[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: doc: Define scopes for modules selection options

Andrew Shark <[email protected]>
Newsgroups gmane.comp.kde.doc,gmane.comp.kde.cvs
Message-ID <[email protected]>
Git commit 43eee5b154b425e6ed3072eee4b3635d64c8efb0 by Andrew Shark.
Committed on 29/01/2024 at 21:21.
Pushed by ashark into branch 'docbook_historied_per_file'.

doc: Define scopes for modules selection options

Original commit: d974610e
https://invent.kde.org/sdk/kdesrc-build/-/commit/d974610efba6140798b10d13d092558e9226f796

M  +16   -16   doc/kdesrc-buildrc/conf-options-table.docbook

https://invent.kde.org/sdk/kdesrc-build/-/commit/43eee5b154b425e6ed3072eee4b3635d64c8efb0

diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index 345ef74e..b35d520c 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -1,17 +1,16 @@
 <sect1 id="conf-options-table">
 <title>Table of available configuration options</title>
 
-<para>Here is a table of the various options, containing the following
+<para>Here are tables of various options, containing the following
 information:</para>
 
 <itemizedlist>
 
 <listitem><para>The option name</para></listitem>
 
-<listitem><para>A description of how &kdesrc-build; responds if the option is
-set in both the global section, and the module section of the <link
-linkend="configure-data">configuration file</link> while building a
-module.</para></listitem>
+<listitem><para>The scope of the option: <emphasis>global</emphasis>, <emphasis>module</emphasis> or <emphasis>module-set</emphasis>.
+Options in <emphasis>module</emphasis> or/and <emphasis>module-set</emphasis> scope can also be defined in <emphasis>options</emphasis> sections.
+</para></listitem>
 
 <listitem><para>Special comments on the purpose and usage of the
 option.</para></listitem>
@@ -1316,7 +1315,7 @@ installations. However this only works on build systems that support
 
 <row id="conf-no-src">
 <entry><link linkend="conf-no-src">no-src</link></entry>
-<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member><member>options</member></simplelist></entry>
+<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member></simplelist></entry>
 <entry>
 <para>Remove <emphasis>update</emphasis> phase. The other phases that were presented will still be processed.</para>
 <para>Related command-line option: <xref linkend="cmdline-no-src"/></para>
@@ -1325,7 +1324,7 @@ installations. However this only works on build systems that support
 
 <row id="conf-no-install">
 <entry><link linkend="conf-no-install">no-install</link></entry>
-<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member><member>options</member></simplelist></entry>
+<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member></simplelist></entry>
 <entry>
 <para>Remove <emphasis>install</emphasis> phase. The other phases that were presented will still be processed.</para>
 <para>Related command-line option: <xref linkend="cmdline-no-install"/></para>
@@ -1334,7 +1333,7 @@ installations. However this only works on build systems that support
 
 <row id="conf-no-tests">
 <entry><link linkend="conf-no-tests">no-tests</link></entry>
-<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member><member>options</member></simplelist></entry>
+<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member></simplelist></entry>
 <entry>
 <para>Remove <emphasis>test</emphasis> phase. The other phases that were presented will still be processed.</para>
 <para>Related command-line option: --no-tests</para>
@@ -1343,7 +1342,7 @@ installations. However this only works on build systems that support
 
 <row id="conf-no-build">
 <entry><link linkend="conf-no-build">no-build</link></entry>
-<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member><member>options</member></simplelist></entry>
+<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member></simplelist></entry>
 <entry>
 <para>Remove <emphasis>build</emphasis> phase. The other phases that were presented will still be processed.</para>
 <para>Related command-line option: <xref linkend="cmdline-no-build"/></para>
@@ -1352,7 +1351,7 @@ installations. However this only works on build systems that support
 
 <row id="conf-build-only">
 <entry><link linkend="conf-build-only">build-only</link></entry>
-<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member><member>options</member></simplelist></entry>
+<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member></simplelist></entry>
 <entry>
 <para>If had <emphasis>build</emphasis> phase, remove any other phases. Otherwise, remove all phases.</para>
 <para>Related command-line option: <xref linkend="cmdline-build-only"/></para>
@@ -1361,7 +1360,7 @@ installations. However this only works on build systems that support
 
 <row id="conf-install-only">
 <entry><link linkend="conf-install-only">install-only</link></entry>
-<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member><member>options</member></simplelist></entry>
+<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member></simplelist></entry>
 <entry>
 <para>If had <emphasis>install</emphasis> phase, remove any other phases. Otherwise, remove all phases.</para>
 <para>Related command-line option: <xref linkend="cmdline-install-only"/></para>
@@ -1370,7 +1369,7 @@ installations. However this only works on build systems that support
 
 <row id="conf-uninstall">
 <entry><link linkend="conf-uninstall">uninstall</link></entry>
-<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member><member>options</member></simplelist></entry>
+<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member></simplelist></entry>
 <entry>
 <para>If had <emphasis>uninstall</emphasis> phase, remove any other phases. Otherwise, remove all phases.</para>
 <para>Related command-line option: --uninstall</para>
@@ -1379,7 +1378,7 @@ installations. However this only works on build systems that support
 
 <row id="conf-filter-out-phases">
 <entry><link linkend="conf-filter-out-phases">filter-out-phases</link></entry>
-<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member><member>options</member></simplelist></entry>
+<entry><simplelist type='vert'><member>global</member><member>module</member><member>module-set</member></simplelist></entry>
 <entry>
 <para>Remove those phases that are listed (space separated) in this option. The other phases that were presented will still be processed.</para>
 </entry>
@@ -1390,12 +1389,13 @@ installations. However this only works on build systems that support
 </table>
 
 <table id="options-module-set-table">
-<title>Module-set and global scope options</title>
+<title>Modules selection options</title>
 <tgroup cols="2">
 
 <thead>
 <row>
 <entry>Option name</entry>
+<entry>Scope</entry>
 <entry>Description</entry>
 </row>
 </thead>
@@ -1404,12 +1404,12 @@ installations. However this only works on build systems that support
 
 <row id="conf-ignore-modules">
 <entry><link linkend="conf-ignore-modules">ignore-modules</link></entry>
+<entry><simplelist type='vert'><member>global</member><member>module-set</member></simplelist></entry>
 <entry>
 <simplelist type='horiz' columns='2'>
 <member>Type</member><member>String</member>
 <member>Available since</member><member>1.16</member>
 </simplelist>
-<para>This option can be used in global section and in module-sets.</para>
 <para>Note that when specified in global section, &cmd-ignore-modules; cmdline option does not override this, but instead appends.</para>
 <para>Modules named by this option, which would be chosen by &kdesrc-build;
 due to a <link linkend="conf-use-modules">use-modules</link> option, are
@@ -1436,12 +1436,12 @@ is compared).</para>
 
 <row id="conf-use-modules">
 <entry><link linkend="conf-use-modules">use-modules</link></entry>
+<entry><simplelist type='vert'><member>module-set</member></simplelist></entry>
 <entry>
 <simplelist type='horiz' columns='2'>
 <member>Type</member><member>String</member>
 <member>Available since</member><member>1.12.1</member>
 </simplelist>
-<para>Can only be used in <link linkend="module-sets">module-set</link>.</para>
 <para>This option allows you to easily
 specify many different modules to build at the same point in <link
 linkend="kdesrc-buildrc">the configuration file</link>.</para>
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.