Git commit 4e0a8ad0db52e3f519214c740aa21ea7f0efa5c8 by Andrew Shark. Committed on 16/01/2024 at 20:55. Pushed by ashark into branch 'master'.
doc: Add self links to the listed entries Currently, the anchors are not rendered, see https://bugs.kde.org/show_bug.cgi?id=479910 To workaround, we will use links to the items itself, so users could easily copy and share the link to the option. M +60 -60 doc/conf-options-table.docbook M +53 -53 doc/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/4e0a8ad0db52e3f519214c740aa21ea7f0efa5c8 diff --git a/doc/conf-options-table.docbook b/doc/conf-options-table.docbook index da8b7da1..7ee10c94 100644 --- a/doc/conf-options-table.docbook +++ b/doc/conf-options-table.docbook @@ -31,7 +31,7 @@ option.</para></listitem> <tbody> <row id="conf-async"> -<entry>async</entry> +<entry><link linkend="conf-async">async</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -44,7 +44,7 @@ all of the source code updates before starting the build process.</para></entry> </row> <row id="conf-colorful-output"> -<entry>colorful-output</entry> +<entry><link linkend="conf-colorful-output">colorful-output</link></entry> <entry><simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> <member>Default value</member><member>True</member> @@ -56,7 +56,7 @@ color codes to anything but a terminal (such as xterm, &konsole;, or the normal </row> <row id="conf-disable-agent-check"> -<entry>disable-agent-check</entry> +<entry><link linkend="conf-disable-agent-check">disable-agent-check</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -71,7 +71,7 @@ for every module.</para> </row> <row id="conf-git-desired-protocol"> -<entry>git-desired-protocol</entry> +<entry><link linkend="conf-git-desired-protocol">git-desired-protocol</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -105,7 +105,7 @@ protocol is most efficient.</para> </row> <row id="conf-install-environment-driver"> -<entry>install-environment-driver</entry> +<entry><link linkend="conf-install-environment-driver">install-environment-driver</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -141,7 +141,7 @@ command-line option.</para></tip> </row> <row id="conf-install-session-driver"> -<entry>install-session-driver</entry> +<entry><link linkend="conf-install-session-driver">install-session-driver</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -171,7 +171,7 @@ command-line option.</para></tip> </row> <row id="conf-niceness"> -<entry>niceness</entry> +<entry><link linkend="conf-niceness">niceness</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Integer</member> @@ -184,7 +184,7 @@ number, the "nicer" the program is.</para> </row> <row id="conf-num-cores"> -<entry>num-cores</entry> +<entry><link linkend="conf-num-cores">num-cores</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Integer</member> @@ -202,7 +202,7 @@ option's usage.</para> </row> <row id="conf-num-cores-low-mem"> -<entry>num-cores-low-mem</entry> +<entry><link linkend="conf-num-cores-low-mem">num-cores-low-mem</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Integer</member> @@ -229,7 +229,7 @@ set to 2.</para> </row> <row id="conf-persistent-data-file"> -<entry>persistent-data-file</entry> +<entry><link linkend="conf-persistent-data-file">persistent-data-file</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -249,7 +249,7 @@ so that different configurations do not end up with conflicting persistent data. </row> <row id="conf-ssh-identity-file"> -<entry>ssh-identity-file</entry> +<entry><link linkend="conf-ssh-identity-file">ssh-identity-file</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -263,7 +263,7 @@ linkend="ssh-agent-reminder"/>.</para> </row> <row id="conf-use-idle-io-priority"> -<entry>use-idle-io-priority</entry> +<entry><link linkend="conf-use-idle-io-priority">use-idle-io-priority</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -277,7 +277,7 @@ running times for &kdesrc-build;.</para> </row> <row id="conf-use-inactive-modules"> -<entry>use-inactive-modules</entry> +<entry><link linkend="conf-use-inactive-modules">use-inactive-modules</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -307,7 +307,7 @@ running times for &kdesrc-build;.</para> <tbody> <row id="conf-binpath"> -<entry>binpath</entry> +<entry><link linkend="conf-binpath">binpath</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -323,7 +323,7 @@ may use the tilde (~) for any paths you add using this option.</para> </row> <row id="conf-branch"> -<entry>branch</entry> +<entry><link linkend="conf-branch">branch</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -337,7 +337,7 @@ option for case-by-case exceptions.</para></note> </row> <row id="conf-branch-group"> -<entry>branch-group</entry> +<entry><link linkend="conf-branch-group">branch-group</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -373,7 +373,7 @@ linkend="kde-projects-module-sets"/>. </row> <row id="conf-build-dir"> -<entry>build-dir</entry> +<entry><link linkend="conf-build-dir">build-dir</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -408,7 +408,7 @@ class="directory">/home/user-name/builddir</filename>.</para></listitem> </row> <row id="conf-build-when-unchanged"> -<entry>build-when-unchanged</entry> +<entry><link linkend="conf-build-when-unchanged">build-when-unchanged</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -435,7 +435,7 @@ change at all.</para></important> </row> <row id="conf-cmake-generator"> -<entry>cmake-generator</entry> +<entry><link linkend="conf-cmake-generator">cmake-generator</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -454,7 +454,7 @@ value for <literal>cmake-generator</literal>.</para></entry> </row> <row id="conf-cmake-toolchain"> -<entry>cmake-toolchain</entry> +<entry><link linkend="conf-cmake-toolchain">cmake-toolchain</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -474,7 +474,7 @@ value for <literal>cmake-toolchain</literal>.</para></entry> </row> <row id="conf-cmake-options"> -<entry>cmake-options</entry> +<entry><link linkend="conf-cmake-options">cmake-options</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -516,7 +516,7 @@ are set for you automatically)</para></entry> </row> <row id="conf-compile-commands-export"> -<entry>compile-commands-export</entry> +<entry><link linkend="conf-compile-commands-export">compile-commands-export</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -528,7 +528,7 @@ are set for you automatically)</para></entry> </row> <row id="conf-compile-commands-linking"> -<entry>compile-commands-linking</entry> +<entry><link linkend="conf-compile-commands-linking">compile-commands-linking</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -541,7 +541,7 @@ inside the build directory to the matching source directory. </row> <row id="conf-configure-flags"> -<entry>configure-flags</entry> +<entry><link linkend="conf-configure-flags">configure-flags</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -560,7 +560,7 @@ only works for qt.</emphasis></para> </row> <row id="conf-custom-build-command"> -<entry>custom-build-command</entry> +<entry><link linkend="conf-custom-build-command">custom-build-command</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -580,7 +580,7 @@ only works for qt.</emphasis></para> </row> <row id="conf-cxxflags"> -<entry>cxxflags</entry> +<entry><link linkend="conf-cxxflags">cxxflags</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -603,7 +603,7 @@ linkend="conf-cmake-options">cmake-options</link> option. </row> <row id="conf-dest-dir"> -<entry>dest-dir</entry> +<entry><link linkend="conf-dest-dir">dest-dir</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -619,7 +619,7 @@ or directory separators in the name as this will interfere with any </row> <row id="conf-do-not-compile"> -<entry>do-not-compile</entry> +<entry><link linkend="conf-do-not-compile">do-not-compile</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -640,7 +640,7 @@ options.</para> </row> <row id="conf-git-user"> -<entry>git-user</entry> +<entry><link linkend="conf-git-user">git-user</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -669,7 +669,7 @@ email address <quote>f...@abc.xyz</quote> would use:</para> </row> <row id="conf-http-proxy"> -<entry>http-proxy</entry> +<entry><link linkend="conf-http-proxy">http-proxy</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -687,7 +687,7 @@ on also use that proxy server, if possible, by setting the </row> <row id="conf-directory-layout"> -<entry>directory-layout</entry> +<entry><link linkend="conf-directory-layout">directory-layout</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -720,7 +720,7 @@ due to changes in the project metadata.</para> </row> <row id="conf-generate-vscode-project-config"> -<entry>generate-vscode-project-config</entry> +<entry><link linkend="conf-generate-vscode-project-config">generate-vscode-project-config</link></entry> <entry> <simplelist type='horiz' columns='2'> @@ -747,7 +747,7 @@ for working on most KDE projects.</para> </row> <row id="conf-include-dependencies"> -<entry>include-dependencies</entry> +<entry><link linkend="conf-include-dependencies">include-dependencies</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -769,7 +769,7 @@ common operating systems.</para> </row> <row id="conf-install-after-build"> -<entry>install-after-build</entry> +<entry><link linkend="conf-install-after-build">install-after-build</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -783,7 +783,7 @@ flag.</para> </row> <row id="conf-install-dir"> -<entry>install-dir</entry> +<entry><link linkend="conf-install-dir">install-dir</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -804,7 +804,7 @@ in the path to have them expanded to the module's name.</para> </row> <row id="conf-libname"> -<entry>libname</entry> +<entry><link linkend="conf-libname">libname</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -818,7 +818,7 @@ but if the guess is wrong then it can be changed with this setting.</para> </row> <row id="conf-libpath"> -<entry>libpath</entry> +<entry><link linkend="conf-libpath">libpath</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -833,7 +833,7 @@ You may use the tilde (~) for any paths you add using this option.</para> </row> <row id="conf-log-dir"> -<entry>log-dir</entry> +<entry><link linkend="conf-log-dir">log-dir</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -844,7 +844,7 @@ generated by the script.</para> </row> <row id="conf-make-install-prefix"> -<entry>make-install-prefix</entry> +<entry><link linkend="conf-make-install-prefix">make-install-prefix</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -856,7 +856,7 @@ please be careful while dealing with root privileges.</para></entry> </row> <row id="conf-make-options"> -<entry>make-options</entry> +<entry><link linkend="conf-make-options">make-options</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -874,7 +874,7 @@ setting.</para> </row> <row id="conf-manual-build"> -<entry>manual-build</entry> +<entry><link linkend="conf-manual-build">manual-build</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -893,7 +893,7 @@ command line option. </row> <row id="conf-manual-update"> -<entry>manual-update</entry> +<entry><link linkend="conf-manual-update">manual-update</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -907,7 +907,7 @@ commented it out.</para> </row> <row id="conf-ninja-options"> -<entry>ninja-options</entry> +<entry><link linkend="conf-ninja-options">ninja-options</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -938,7 +938,7 @@ end options </row> <row id="conf-no-src"> -<entry>no-src</entry> +<entry><link linkend="conf-no-src">no-src</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -951,7 +951,7 @@ module if it normally would have tried anyways.</para> </row> <row id="conf-override-build-system"> -<entry>override-build-system</entry> +<entry><link linkend="conf-override-build-system">override-build-system</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1006,7 +1006,7 @@ the auto-detection. In this case you can manually specify the correct build type </row> <row id="conf-purge-old-logs"> -<entry>purge-old-logs</entry> +<entry><link linkend="conf-purge-old-logs">purge-old-logs</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -1018,7 +1018,7 @@ deleted or not.</para> </row> <row id="conf-qmake-options"> -<entry>qmake-options</entry> +<entry><link linkend="conf-qmake-options">qmake-options</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1034,7 +1034,7 @@ installs the module. </row> <row id="conf-qtdir"> -<entry>qtdir</entry> +<entry><link linkend="conf-qtdir">qtdir</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1047,7 +1047,7 @@ provided by the operating system. </row> <row id="conf-remove-after-install"> -<entry>remove-after-install</entry> +<entry><link linkend="conf-remove-after-install">remove-after-install</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1074,7 +1074,7 @@ since &kdesrc-build; will be unable to perform incremental builds.</para> </row> <row id="conf-repository"> -<entry>repository</entry> +<entry><link linkend="conf-repository">repository</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1087,7 +1087,7 @@ specify the &git; repository to download the source code for the module. </row> <row id="conf-revision"> -<entry>revision</entry> +<entry><link linkend="conf-revision">revision</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1103,7 +1103,7 @@ configuration.</para> </row> <row id="conf-run-tests"> -<entry>run-tests</entry> +<entry><link linkend="conf-run-tests">run-tests</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -1117,7 +1117,7 @@ to ensure their system is setup correctly.</para></entry> </row> <row id="conf-set-env"> -<entry>set-env</entry> +<entry><link linkend="conf-set-env">set-env</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1137,7 +1137,7 @@ globally).</para> </row> <row id="conf-source-dir"> -<entry>source-dir</entry> +<entry><link linkend="conf-source-dir">source-dir</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1150,7 +1150,7 @@ to represent the home directory if using this option.</para> </row> <row id="conf-stop-on-failure"> -<entry>stop-on-failure</entry> +<entry><link linkend="conf-stop-on-failure">stop-on-failure</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -1162,7 +1162,7 @@ after an error occurs during the build or install process.</para> </row> <row id="conf-tag"> -<entry>tag</entry> +<entry><link linkend="conf-tag">tag</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1177,7 +1177,7 @@ url="https://download.kde.org/";>&kde; download site</ulink>.</para> </row> <row id="conf-use-clean-install"> -<entry>use-clean-install</entry> +<entry><link linkend="conf-use-clean-install">use-clean-install</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>Boolean</member> @@ -1214,7 +1214,7 @@ installations. However this only works on build systems that support <tbody> <row id="conf-git-repository-base"> -<entry>git-repository-base</entry> +<entry><link linkend="conf-git-repository-base">git-repository-base</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1274,7 +1274,7 @@ different module sets.</para></tip> </row> <row id="conf-ignore-modules"> -<entry>ignore-modules</entry> +<entry><link linkend="conf-ignore-modules">ignore-modules</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> @@ -1305,7 +1305,7 @@ is compared).</para> </row> <row id="conf-use-modules"> -<entry>use-modules</entry> +<entry><link linkend="conf-use-modules">use-modules</link></entry> <entry> <simplelist type='horiz' columns='2'> <member>Type</member><member>String</member> diff --git a/doc/supported-cmdline-params.docbook b/doc/supported-cmdline-params.docbook index 219c9099..494a3363 100644 --- a/doc/supported-cmdline-params.docbook +++ b/doc/supported-cmdline-params.docbook @@ -6,7 +6,7 @@ <variablelist> <varlistentry id="cmdline-pretend"> -<term><option>--pretend</option> (or <option>--dry-run</option> or <option>-p</option>)</term> +<term><option><link linkend="cmdline-pretend">--pretend</link></option> (or <option>--dry-run</option> or <option>-p</option>)</term> <listitem><para> &kdesrc-build; will run through the update and build process, but instead of performing any actions to update or build, will instead output what the @@ -29,7 +29,7 @@ first. </varlistentry> <varlistentry id="cmdline-include-dependencies"> -<term><option>--include-dependencies</option> (or <option>-d</option>), <option>--no-include-dependencies</option> (or <option>-D</option>)</term> +<term><option><link linkend="cmdline-include-dependencies">--include-dependencies</link></option> (or <option>-d</option>), <option>--no-include-dependencies</option> (or <option>-D</option>)</term> <listitem><para> This option causes &kdesrc-build; to automatically include other &kde; and &Qt; modules in the build, if required for the modules you have requested to build @@ -47,7 +47,7 @@ management system. See <xref linkend="kde-projects-module-sets"/>.</para> </varlistentry> <varlistentry id="cmdline-ignore-modules"> -<term><option>--ignore-modules</option> (or <option>-!</option>) <parameter>module [module ...]</parameter></term> +<term><option><link linkend="cmdline-ignore-modules">--ignore-modules</link></option> (or <option>-!</option>) <parameter>module [module ...]</parameter></term> <listitem><para> Do not include the modules passed on the rest of the command line in the update/build process (this is useful if you want to build most of the modules @@ -57,7 +57,7 @@ a few). </varlistentry> <varlistentry id="cmdline-run"> -<term><option>--run</option> (or <option>--start-program</option>) <parameter>program [parameters ...]</parameter></term> +<term><option><link linkend="cmdline-run">--run</link></option> (or <option>--start-program</option>) <parameter>program [parameters ...]</parameter></term> <listitem><para> This option interprets the next item on the command line as a program to run, and &kdesrc-build; will then finish reading the configuration file, update the @@ -86,7 +86,7 @@ QMAIL_CONTROLDIR=/var/qmail/control </varlistentry> <varlistentry id="cmdline-revision"> -<term><option>--revision</option> <replaceable>id</replaceable></term> +<term><option><link linkend="cmdline-revision">--revision</link></option> <replaceable>id</replaceable></term> <listitem><para> This option causes &kdesrc-build; to checkout a specific numbered revision for each &git; module, overriding any <link linkend="conf-branch">branch</link>, @@ -99,7 +99,7 @@ compatibility with older scripts. </varlistentry> <varlistentry id="cmdline-delete-my-patches"> -<term><option>--delete-my-patches</option>, <option>--no-delete-my-patches</option></term> +<term><option><link linkend="cmdline-delete-my-patches">--delete-my-patches</link></option>, <option>--no-delete-my-patches</option></term> <listitem><para> This option is used to let &kdesrc-build; delete source directories that may contain user data, so that the module can be re-downloaded. This would normally @@ -112,7 +112,7 @@ deleted).</para> </varlistentry> <varlistentry id="cmdline-delete-my-settings"> -<term><option>--delete-my-settings</option>, <option>--no-delete-my-settings</option></term> +<term><option><link linkend="cmdline-delete-my-settings">--delete-my-settings</link></option>, <option>--no-delete-my-settings</option></term> <listitem><para> This option is used to let &kdesrc-build; overwrite existing files which may contain user data.</para> @@ -123,8 +123,8 @@ with it if it is needed.</para> </listitem> </varlistentry> -<varlistentry id="cmdline-global-option"> -<term><option>--<replaceable><option-name></replaceable></option> <replaceable>value</replaceable></term> +<varlistentry id="cmdline-option-name"> +<term><option><link linkend="cmdline-option-name">--<replaceable><option-name></replaceable></link></option> <replaceable>value</replaceable></term> <listitem><para> You can use this option to override an option in your <link linkend="configure-data">configuration file</link> for every module. For instance, to override the <link @@ -143,8 +143,8 @@ preferred by &kdesrc-build;. </listitem> </varlistentry> -<varlistentry id="cmdline-module-option"> -<term><option>--set-module-option-value <replaceable><module-name></replaceable>,<replaceable><option-name></replaceable>,<replaceable><option-value></replaceable></option></term> +<varlistentry id="cmdline-set-module-option-value"> +<term><option><link linkend="cmdline-set-module-option-value">--set-module-option-value</link> <replaceable><module-name></replaceable>,<replaceable><option-name></replaceable>,<replaceable><option-value></replaceable></option></term> <listitem><para> You can use this option to override an option in your <link linkend="configure-data">configuration file</link> for a specific module. @@ -159,7 +159,7 @@ a specific module. <variablelist> <varlistentry id="cmdline-resume-from"> -<term><option>--resume-from</option> (or <option>--from</option> or <option>-f</option>) <replaceable>module</replaceable></term> +<term><option><link linkend="cmdline-resume-from">--resume-from</link></option> (or <option>--from</option> or <option>-f</option>) <replaceable>module</replaceable></term> <listitem><para>This option is used to resume the build starting from the given module. You should not specify other module names on the command line. </para> @@ -176,7 +176,7 @@ build.</para></listitem> </varlistentry> <varlistentry id="cmdline-resume-after"> -<term><option>--resume-after</option> (or <option>--after</option> or <option>-a</option>) <replaceable>module</replaceable></term> +<term><option><link linkend="cmdline-resume-after">--resume-after</link></option> (or <option>--after</option> or <option>-a</option>) <replaceable>module</replaceable></term> <listitem><para> This option is used to resume the build starting after the given module. You should not specify other module names on the command line. @@ -195,7 +195,7 @@ module.</para></listitem> </varlistentry> <varlistentry id="cmdline-resume"> -<term><option>--resume</option></term> +<term><option><link linkend="cmdline-resume">--resume</link></option></term> <listitem><para> This option can be used to run &kdesrc-build; after it has had a build failure. @@ -211,7 +211,7 @@ building the modules you were building before, without fiddling with </varlistentry> <varlistentry id="cmdline-stop-before"> -<term><option>--stop-before</option> (or <option>--until</option>) <replaceable>module</replaceable></term> +<term><option><link linkend="cmdline-stop-before">--stop-before</link></option> (or <option>--until</option>) <replaceable>module</replaceable></term> <listitem><para> This option is used to stop the normal build process just <emphasis>before</emphasis> a module would ordinarily be built. @@ -224,7 +224,7 @@ then <option>--stop-before <replaceable>moduleB</replaceable></option> would cau </varlistentry> <varlistentry id="cmdline-stop-after"> -<term><option>--stop-after</option> (or <option>--to</option>) <replaceable>module</replaceable></term> +<term><option><link linkend="cmdline-stop-after">--stop-after</link></option> (or <option>--to</option>) <replaceable>module</replaceable></term> <listitem><para> This option is used to stop the normal build process just <emphasis>after</emphasis> a module would ordinarily be built. @@ -237,7 +237,7 @@ then <option>--stop-after <replaceable>moduleB</replaceable></option> would caus </varlistentry> <varlistentry id="cmdline-stop-on-failure"> -<term><option>--stop-on-failure</option>, <option>--no-stop-on-failure</option></term> +<term><option><link linkend="cmdline-stop-on-failure">--stop-on-failure</link></option>, <option>--no-stop-on-failure</option></term> <listitem><para> This option controls if the build will be aborted as soon as a failure occurs. Default behavior is --stop-on-failure. You may override it if you wish to press on with the rest of the modules in the build, @@ -248,7 +248,7 @@ See also the <link linkend="conf-stop-on-failure">stop-on-failure</link> configu </varlistentry> <varlistentry id="cmdline-rebuild-failures"> -<term><option>--rebuild-failures</option></term> +<term><option><link linkend="cmdline-rebuild-failures">--rebuild-failures</link></option></term> <listitem><para> Use this option to build only those modules which failed to build on a previous &kdesrc-build; run. This is useful if a significant number of failures occurred mixed with @@ -271,7 +271,7 @@ work.</para></note> <variablelist> <varlistentry id="cmdline-query"> -<term><option>--query</option> <userinput><replaceable>mode</replaceable></userinput></term> +<term><option><link linkend="cmdline-query">--query</link></option> <userinput><replaceable>mode</replaceable></userinput></term> <listitem><para> This command causes &kdesrc-build; to query a parameter of the modules in the build list (either passed on the command line or read in from the configuration @@ -326,7 +326,7 @@ kdepim: master <varlistentry id="cmdline-print-modules"> -<term><option>--print-modules</option></term> +<term><option><link linkend="cmdline-print-modules">--print-modules</link></option></term> <listitem> <para> Takes all actions up to and including dependency reordering of the modules @@ -356,7 +356,7 @@ kdepim: master </varlistentry> <varlistentry id="cmdline-list-build"> -<term><option>--list-build</option></term> +<term><option><link linkend="cmdline-list-build">--list-build</link></option></term> <listitem> <para> Lists the modules that would be built, in the order in which they would be built. @@ -373,7 +373,7 @@ kdepim: master </varlistentry> <varlistentry id="cmdline-dependency-tree"> -<term><option>--dependency-tree</option></term> +<term><option><link linkend="cmdline-dependency-tree">--dependency-tree</link></option></term> <listitem> <para> Prints out dependency information on the modules that would be built using a tree @@ -385,7 +385,7 @@ kdepim: master </varlistentry> <varlistentry id="cmdline-dependency-tree-fullpath"> -<term><option>--dependency-tree-fullpath</option></term> +<term><option><link linkend="cmdline-dependency-tree-fullpath">--dependency-tree-fullpath</link></option></term> <listitem> <para> Prints out dependency information on the modules that would be built using a tree @@ -403,7 +403,7 @@ kdepim: master <variablelist> <varlistentry id="cmdline-no-metadata"> -<term><option>--no-metadata</option></term> +<term><option><link linkend="cmdline-no-metadata">--no-metadata</link></option></term> <listitem><para> Do not automatically download the extra metadata needed for &kde; git modules. The source updates for the modules themselves will still occur unless you pass @@ -418,21 +418,21 @@ one time and then using this option for subsequent runs. </varlistentry> <varlistentry id="cmdline-no-src"> -<term><option>--no-src</option> (or <option>-S</option>)</term> +<term><option><link linkend="cmdline-no-src">--no-src</link></option> (or <option>-S</option>)</term> <listitem><para> Skip contacting the &git; server. </para></listitem> </varlistentry> <varlistentry id="cmdline-no-build"> -<term><option>--no-build</option></term> +<term><option><link linkend="cmdline-no-build">--no-build</link></option></term> <listitem><para> Skip the build process. </para></listitem> </varlistentry> <varlistentry id="cmdline-no-install"> -<term><option>--no-install</option></term> +<term><option><link linkend="cmdline-no-install">--no-install</link></option></term> <listitem><para> Do not automatically install packages after they are built. </para></listitem> @@ -446,7 +446,7 @@ Do not automatically install packages after they are built. <variablelist> <varlistentry id="cmdline-metadata-only"> -<term><option>--metadata-only</option></term> +<term><option><link linkend="cmdline-metadata-only">--metadata-only</link></option></term> <listitem><para> Only perform the metadata download process. &kdesrc-build; normally handles this automatically, but you might manually use this to allow the <option><link @@ -455,21 +455,21 @@ linkend="cmdline-pretend">--pretend</link></option> command line option to work. </varlistentry> <varlistentry id="cmdline-src-only"> -<term><option>--src-only</option> (or <option>-s</option>)</term> +<term><option><link linkend="cmdline-src-only">--src-only</link></option> (or <option>-s</option>)</term> <listitem><para> Only perform the source update. </para></listitem> </varlistentry> <varlistentry id="cmdline-build-only"> -<term><option>--build-only</option></term> +<term><option><link linkend="cmdline-build-only">--build-only</link></option></term> <listitem><para> Only perform the build process. </para></listitem> </varlistentry> <varlistentry id="cmdline-install-only"> -<term><option>--install-only</option></term> +<term><option><link linkend="cmdline-install-only">--install-only</link></option></term> <listitem><para> If this is the only command-line option, it tries to install all the modules contained in <filename>log/latest/build-status</filename>. If command-line @@ -480,7 +480,7 @@ the last run). </varlistentry> <varlistentry id="cmdline-build-system-only"> -<term><option>--build-system-only</option></term> +<term><option><link linkend="cmdline-build-system-only">--build-system-only</link></option></term> <listitem><para> This option causes &kdesrc-build; to abort building a module just before the <command>make</command> command would have been run. This is supported @@ -497,7 +497,7 @@ the current &kde; build system. <variablelist> <varlistentry id="cmdline-build-when-unchanged"> -<term><option>--build-when-unchanged</option> (or <option>--force-build</option>), <option>--no-build-when-unchanged</option> (or <option>--no-force-build</option>)</term> +<term><option><link linkend="cmdline-build-when-unchanged">--build-when-unchanged</link></option> (or <option>--force-build</option>), <option>--no-build-when-unchanged</option> (or <option>--no-force-build</option>)</term> <listitem><para> Enabling this option explicitly disables skipping the build process (an optimization controlled by the <link @@ -508,14 +508,14 @@ that &kdesrc-build; cannot check. This option is enabled by default.</para> </varlistentry> <varlistentry id="cmdline-refresh-build"> -<term><option>--refresh-build</option> (or <option>-r</option>)</term> +<term><option><link linkend="cmdline-refresh-build">--refresh-build</link></option> (or <option>-r</option>)</term> <listitem><para> Recreate the build system and make from scratch. </para></listitem> </varlistentry> <varlistentry id="cmdline-reconfigure"> -<term><option>--reconfigure</option></term> +<term><option><link linkend="cmdline-reconfigure">--reconfigure</link></option></term> <listitem><para> Run <command>cmake</command> (for &kde; modules) or <command>configure</command> (for &Qt;) again, without cleaning the build @@ -527,7 +527,7 @@ linkend="cmdline-refresh-build">--refresh-build</link></parameter> is used. </varlistentry> <varlistentry id="cmdline-install-dir"> -<term><option>--install-dir <replaceable>path</replaceable></option></term> +<term><option><link linkend="cmdline-install-dir">--install-dir</link> <replaceable>path</replaceable></option></term> <listitem><para> This allows you to change the directory where modules will be installed to. This option implies <link linkend="cmdline-reconfigure"><option>--reconfigure</option></link>, @@ -537,7 +537,7 @@ may still be required. </varlistentry> <varlistentry id="cmdline-generate-vscode-project-config"> -<term><option>--generate-vscode-project-config</option>, <option>--no-generate-vscode-project-config</option></term> +<term><option><link linkend="cmdline-generate-vscode-project-config">--generate-vscode-project-config</link></option>, <option>--no-generate-vscode-project-config</option></term> <listitem><para> Generate a <filename>.vscode</filename> directory with configurations for building and debugging in Visual Studio Code. This option is disabled by default. @@ -552,7 +552,7 @@ in Visual Studio Code. This option is disabled by default. <variablelist> <varlistentry id="cmdline-async"> -<term><option>--async</option>, <option>--no-async</option></term> +<term><option><link linkend="cmdline-async">--async</link></option>, <option>--no-async</option></term> <listitem><para> Enables or disables the <link linkend="conf-async">asynchronous mode</link>, which can perform the source code updates and module builds at the same time. @@ -564,14 +564,14 @@ while running &kdesrc-build; try disabling it, and submitting a </varlistentry> <varlistentry id="cmdline-color"> -<term><option>--color</option> (or <option>--colorful-output</option>), <option>--no-color</option> (or <option>--no-colorful-output</option>)</term> +<term><option><link linkend="cmdline-color">--color</link></option> (or <option>--colorful-output</option>), <option>--no-color</option> (or <option>--no-colorful-output</option>)</term> <listitem><para> Enable or disable colorful output. By default, this option is enabled for interactive terminals. </para></listitem> </varlistentry> <varlistentry id="cmdline-nice"> -<term><option>--nice</option> (or <option>--niceness</option>) <replaceable>value</replaceable></term> +<term><option><link linkend="cmdline-nice">--nice</link></option> (or <option>--niceness</option>) <replaceable>value</replaceable></term> <listitem><para> This value adjusts the computer CPU priority requested by &kdesrc-build;, and should be in the range of 0-20. 0 is highest priority (because it is the @@ -580,7 +580,7 @@ least <quote>nice</quote>), 20 is the lowest priority. This option defaults to 1 </varlistentry> <varlistentry id="cmdline-rc-file"> -<term><option>--rc-file</option> <replaceable>file</replaceable></term> +<term><option><link linkend="cmdline-rc-file">--rc-file</link></option> <replaceable>file</replaceable></term> <listitem><para> The file to read the configuration options from. The default value for this parameter is <filename>kdesrc-buildrc</filename> (checked in the current working directory). @@ -599,7 +599,7 @@ If this file doesn't exist, <filename>~/.config/kdesrc-buildrc</filename> <variablelist> <varlistentry id="cmdline-initial-setup"> -<term><option>--initial-setup</option></term> +<term><option><link linkend="cmdline-initial-setup">--initial-setup</link></option></term> <listitem><para> Has &kdesrc-build; perform the one-time initial setup necessary to prepare the system for &kdesrc-build; to operate, and for the newly-installed &kde; @@ -620,7 +620,7 @@ software to run. </varlistentry> <varlistentry id="cmdline-install-distro-packages"> -<term><option>--install-distro-packages</option></term> +<term><option><link linkend="cmdline-install-distro-packages">--install-distro-packages</link></option></term> <listitem><para> Installs distro packages (on supported &Linux; distributions) necessary to prepare the system for &kdesrc-build; to operate, and for the newly-installed &kde; software to run. @@ -630,7 +630,7 @@ software to run. </varlistentry> <varlistentry id="cmdline-generate-config"> -<term><option>--generate-config</option></term> +<term><option><link linkend="cmdline-generate-config">--generate-config</link></option></term> <listitem><para> Generate the &kdesrc-build; configuration file. </para> @@ -639,7 +639,7 @@ Generate the &kdesrc-build; configuration file. </varlistentry> <varlistentry id="cmdline-update-shellrc"> -<term><option>--update-shellrc</option></term> +<term><option><link linkend="cmdline-update-shellrc">--update-shellrc</link></option></term> <listitem><para> Edit the "~/.bashrc" (or other shell rc file) to add &kdesrc-build; to your <envar>$PATH</envar> variable and enable autocompletion. </para> @@ -659,7 +659,7 @@ Edit the "~/.bashrc" (or other shell rc file) to add &kdesrc-build; to your <env <variablelist> <varlistentry id="cmdline-debug"> -<term><option>--debug</option></term> +<term><option><link linkend="cmdline-debug">--debug</link></option></term> <listitem><para> Enables debug mode for the script. Currently, this means that all output will be dumped to the standard output in addition to being logged in the log directory @@ -669,7 +669,7 @@ doing in debugging mode. </varlistentry> <varlistentry id="cmdline-quiet"> -<term><option>--quiet</option> (or <option>--quite</option> or <option>-q</option>)</term> +<term><option><link linkend="cmdline-quiet">--quiet</link></option> (or <option>--quite</option> or <option>-q</option>)</term> <listitem><para> Do not be as noisy with the output. With this switch only the basics are output. @@ -677,14 +677,14 @@ output. </varlistentry> <varlistentry id="cmdline-really-quiet"> -<term><option>--really-quiet</option></term> +<term><option><link linkend="cmdline-really-quiet">--really-quiet</link></option></term> <listitem><para> Only output warnings and errors. </para></listitem> </varlistentry> <varlistentry id="cmdline-verbose"> -<term><option>--verbose</option></term> +<term><option><link linkend="cmdline-verbose">--verbose</link></option></term> <listitem><para> Be very descriptive about what is going on, and what &kdesrc-build; is doing. </para></listitem> @@ -698,21 +698,21 @@ Be very descriptive about what is going on, and what &kdesrc-build; is doing. <variablelist> <varlistentry id="cmdline-version"> -<term><option>--version</option> (or <option>-v</option>)</term> +<term><option><link linkend="cmdline-version">--version</link></option> (or <option>-v</option>)</term> <listitem><para> Display the program version. </para></listitem> </varlistentry> <varlistentry id="cmdline-help"> -<term><option>--help</option> (or <option>-h</option>)</term> +<term><option><link linkend="cmdline-help">--help</link></option> (or <option>-h</option>)</term> <listitem><para> Only display simple help on this script. </para></listitem> </varlistentry> <varlistentry id="cmdline-show-info"> -<term><option>--show-info</option></term> +<term><option><link linkend="cmdline-show-info">--show-info</link></option></term> <listitem><para> Displays information about &kdesrc-build; and the operating system, that may prove useful in bug reports or when asking for help in forums or mailing lists. @@ -721,7 +721,7 @@ prove useful in bug reports or when asking for help in forums or mailing lists. </varlistentry> <varlistentry id="cmdline-show-options-specifiers"> -<term><option>--show-options-specifiers</option></term> +<term><option><link linkend="cmdline-show-options-specifiers">--show-options-specifiers</link></option></term> <listitem><para> Print the specifier lines (in the format that GetOpts::Long accepts) for all command line options supported by the script. This may be used by developers, for example, for generating zsh autocompletion functions.
