Git commit 54b5af830ceb16b844a81b4707cb3e5a9ac943ef by Andrew Shark. Committed on 24/01/2024 at 23:36. Pushed by ashark into branch 'master'.
doc: Add related cli options to the config options table M +63 -8 doc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/54b5af830ceb16b844a81b4707cb3e5a9ac943ef diff --git a/doc/conf-options-table.docbook b/doc/conf-options-table.docbook index e19ac4d0..0573f12d 100644 --- a/doc/conf-options-table.docbook +++ b/doc/conf-options-table.docbook @@ -40,7 +40,9 @@ option.</para></listitem> </simplelist> <para>This option enables the asynchronous mode of operation, where the source code update and the build process will be performed in parallel, instead of waiting for -all of the source code updates before starting the build process.</para></entry> +all of the source code updates before starting the build process.</para> +<para>Related command-line option: <xref linkend="cmdline-async"/></para> +</entry> </row> <row id="conf-colorful-output"> @@ -52,6 +54,7 @@ all of the source code updates before starting the build process.</para></entry> Note that &kdesrc-build; will not output the color codes to anything but a terminal (such as xterm, &konsole;, or the normal &Linux; console).</para> +<para>Related command-line option: <xref linkend="cmdline-color"/></para> </entry> </row> @@ -67,6 +70,7 @@ color codes to anything but a terminal (such as xterm, &konsole;, or the normal make sure that if you are using ssh-agent, it is actually managing some &ssh; identities. This is to try and prevent &ssh; from asking for your pass phrase for every module.</para> +<para>Related command-line option: --disable-agent-check, --no-disable-agent-check</para> </entry> </row> @@ -137,6 +141,7 @@ also disabled.</para> unless you also pass the <option><link linkend="cmdline-delete-my-settings">--delete-my-settings</link></option> command-line option.</para></tip> +<para>Related command-line option: --install-environment-driver, --no-install-environment-driver</para> </entry> </row> @@ -167,6 +172,7 @@ option to <replaceable>false</replaceable>. If enabled, this feature also enabl unless you also pass the <option><link linkend="cmdline-delete-my-settings">--delete-my-settings</link></option> command-line option.</para></tip> +<para>Related command-line option: --install-session-driver, --no-install-session-driver</para> </entry> </row> @@ -180,6 +186,7 @@ command-line option.</para></tip> <para>Set this option to a number between 20 and 0. The higher the number, the lower a priority &kdesrc-build; will set for itself, i.e. the higher the number, the "nicer" the program is.</para> +<para>Related command-line option: <xref linkend="cmdline-nice"/></para> </entry> </row> @@ -198,6 +205,7 @@ number of CPUs, this value is set to 4.</para> <para>See <xref linkend="make-options-example"/> for an example of this option's usage.</para> +<para>Related command-line option: --num-cores <replaceable>value</replaceable></para> </entry> </row> @@ -225,6 +233,7 @@ any module in the same way that <option>num-cores</option> is used.</para> <para>If &kdesrc-build; cannot detect available memory then this value will be set to 2.</para> +<para>Related command-line option: --num-cores-low-mem <replaceable>value</replaceable></para> </entry> </row> @@ -245,6 +254,7 @@ be saved to <filename>~/.local/state/kdesrc-build-data</filename> configurations in the same directory, you may want to manually set this option, so that different configurations do not end up with conflicting persistent data. </para> +<para>Related command-line option: --persistent-data-file <replaceable>file</replaceable></para> </entry> </row> @@ -273,6 +283,7 @@ linkend="ssh-agent-reminder"/>.</para> <para>Use lower priority for disk and other I/O, which can significantly improve the responsiveness of the rest of the system at the expense of slightly longer running times for &kdesrc-build;.</para> +<para>Related command-line option: --use-idle-io-priority, --no-use-idle-io-priority</para> </entry> </row> @@ -284,6 +295,7 @@ running times for &kdesrc-build;.</para> <member>Default value</member><member>False</member> </simplelist> <para>Allow kdesrc-build to also clone and pull from repositories marked as inactive.</para> +<para>Related command-line option: --use-inactive-modules, --no-use-inactive-modules</para> </entry> </row> @@ -319,6 +331,7 @@ variable should include the colon-separated paths of your development toolchain. The paths <filename class="directory">${install-dir}/bin</filename> and <filename class="directory">${qt-install-dir}/bin</filename> are automatically added. You may use the tilde (~) for any paths you add using this option.</para> +<para>Related command-line option: --binpath <replaceable>path</replaceable></para> </entry> </row> @@ -333,6 +346,7 @@ may use the tilde (~) for any paths you add using this option.</para> <note><para>For most &kde; modules you probably wish to use the <link linkend="conf-branch-group">branch-group</link> option instead and use this option for case-by-case exceptions.</para></note> +<para>Related command-line option: --branch <replaceable>value</replaceable></para> </entry> </row> @@ -369,6 +383,7 @@ modules (the common case). See also <xref linkend="kde-projects-module-sets"/>. </para></note> +<para>Related command-line option: --branch-group <replaceable>value</replaceable></para> </entry> </row> @@ -404,6 +419,7 @@ class="directory">/home/user-name/builddir</filename>.</para></listitem> </orderedlist> <para>Perhaps surprisingly, this option can be changed per module.</para> +<para>Related command-line option: --build-dir <replaceable>path</replaceable></para> </entry> </row> @@ -431,6 +447,7 @@ other optimizations, there are trade-offs for the correctness of your installation. For instance, changes to the qt or kdelibs modules may cause a rebuild of other modules to be necessary, even if the source code doesn't change at all.</para></important> +<para>Related command-line option: <xref linkend="cmdline-build-when-unchanged"/></para> </entry> </row> @@ -450,7 +467,9 @@ as if unset. <para>Note that if a valid generator is also specified through <link linkend="conf-cmake-options">cmake-options</link> it will override the -value for <literal>cmake-generator</literal>.</para></entry> +value for <literal>cmake-generator</literal>.</para> +<para>Related command-line option: --cmake-generator <replaceable>value</replaceable></para> +</entry> </row> <row id="conf-cmake-toolchain"> @@ -470,7 +489,9 @@ of standard flags added by &kdesrc-build;</link> for more information. </para> <para>Note that if a valid toolchain is also specified through <link linkend="conf-cmake-options">cmake-options</link> it will override the -value for <literal>cmake-toolchain</literal>.</para></entry> +value for <literal>cmake-toolchain</literal>.</para> +<para>Related command-line option: --cmake-toolchain <replaceable>value</replaceable></para> +</entry> </row> <row id="conf-cmake-options"> @@ -512,7 +533,9 @@ cmake-options -DCMAKE_BUILD_TYPE=RelWithDebInfo <para>Since this is a hassle, &kdesrc-build; takes pains to ensure that as long as the rest of the options are set correctly, you should be able to leave this option blank. (In other words, <emphasis>required</emphasis> &cmake; parameters -are set for you automatically)</para></entry> +are set for you automatically)</para> +<para>Related command-line option: --cmake-options <replaceable>value</replaceable></para> +</entry> </row> <row id="conf-compile-commands-export"> @@ -524,6 +547,7 @@ are set for you automatically)</para></entry> </simplelist> <para>Enables the generation of a <literal>compile_commands.json</literal> via CMake inside the build directory. </para> +<para>Related command-line option: --compile-commands-export, --no-compile-commands-export</para> </entry> </row> @@ -537,6 +561,7 @@ are set for you automatically)</para></entry> <para>Enables the creation of symbolic links from <literal>compile_commands.json</literal> generated via CMake inside the build directory to the matching source directory. </para> +<para>Related command-line option: --compile-commands-linking, --no-compile-commands-linking</para> </entry> </row> @@ -556,6 +581,7 @@ only works for qt.</emphasis></para> <para>To change configuration settings for KDE modules, see <link linkend="conf-cmake-options">cmake-options</link>. </para> +<para>Related command-line option: --configure-flags <replaceable>value</replaceable></para> </entry> </row> @@ -576,6 +602,7 @@ only works for qt.</emphasis></para> by the <link linkend="conf-make-options">make-options</link> option as normal. </para> +<para>Related command-line option: --custom-build-command <replaceable>value</replaceable></para> </entry> </row> @@ -599,6 +626,7 @@ necessary to set the CMAKE_BUILD_TYPE option to <userinput>none</userinput> when configuring the module. This can be done using the <link linkend="conf-cmake-options">cmake-options</link> option. </para> +<para>Related command-line option: --cxxflags <replaceable>value</replaceable></para> </entry> </row> @@ -615,6 +643,7 @@ name of the module on disk, it is not a good idea to include directories or directory separators in the name as this will interfere with any <link linkend="conf-build-dir">build-dir</link> or <link linkend="conf-source-dir">source-dir</link> options.</para> +<para>Related command-line option: --dest-dir <replaceable>path</replaceable></para> </entry> </row> @@ -636,6 +665,7 @@ compiling, you would add "do-not-compile juk kscd" to your syntaxhighlighting options.</para> <para>See <xref linkend="not-compiling"/> for an example.</para> +<para>Related command-line option: --do-not-compile <replaceable>value</replaceable></para> </entry> </row> @@ -683,6 +713,7 @@ database</link>).</para> on also use that proxy server, if possible, by setting the <envar>http_proxy</envar> environment variable to the indicated server, <emphasis>if that environment variable is not already set</emphasis>.</para> +<para>Related command-line option: --http-proxy <replaceable>value</replaceable></para> </entry> </row> @@ -716,6 +747,7 @@ project metadata for these modules. This is a good choice if you want a director tracks with certain KDE processes, but note that this path is therefore not always stable. As a result, &kdesrc-build; may abandon an old copy of the repository and clone a new one for a project due to changes in the project metadata.</para> +<para>Related command-line option: --directory-layout <replaceable>value</replaceable></para> </entry> </row> @@ -741,8 +773,7 @@ building, debugging, and running the project from within VS Code.</para> <para>The configuration also recommends extensions to install that are useful for working on most KDE projects.</para> -<para>You can also use the <link linkend="cmdline-generate-vscode-project-config"> -<option>--generate-vscode-project-config</option></link> command line flag.</para> +<para>Related command-line option: <xref linkend="cmdline-generate-vscode-project-config"/></para> </entry> </row> @@ -765,6 +796,7 @@ linkend="conf-branch-group">branch-group</link>.</para></note> <para>This is to support building applications that need versions of &Qt; or &plasma; more recent than supported on common operating systems.</para> +<para>Related command-line option: <xref linkend="cmdline-include-dependencies"/></para> </entry> </row> @@ -779,6 +811,7 @@ common operating systems.</para> You can also use the <link linkend="cmdline-no-install"><option>--no-install</option></link> command line flag.</para> +<para>Related command-line option: --install-after-build, --no-install-after-build</para> </entry> </row> @@ -800,6 +833,7 @@ where the &kde; Platform libraries are installed, such as if you were using &kdesrc-build; only to build applications.</para> <para>You can use <varname>${MODULE}</varname> or <varname>$MODULE</varname> in the path to have them expanded to the module's name.</para> +<para>Related command-line option: <xref linkend="cmdline-install-dir"/></para> </entry> </row> @@ -814,6 +848,7 @@ in the path to have them expanded to the module's name.</para> inside ${install-dir} and ${qt-install-dir}. On many systems this is either "lib" or "lib64". Auto-detection is attempted to set the correct name by default, but if the guess is wrong then it can be changed with this setting.</para> +<para>Related command-line option: --libname <replaceable>value</replaceable></para> </entry> </row> @@ -829,6 +864,7 @@ in a module option. The default value is blank, but the paths <filename class="directory">${install-dir}/$<envar>LIBNAME</envar></filename> and <filename class="directory">${qt-install-dir}/$<envar>LIBNAME</envar></filename> are automatically added. You may use the tilde (~) for any paths you add using this option.</para> +<para>Related command-line option: --libpath <replaceable>path</replaceable></para> </entry> </row> @@ -840,6 +876,7 @@ You may use the tilde (~) for any paths you add using this option.</para> </simplelist> <para>Use this option to change the directory used to hold the log files generated by the script.</para> +<para>Related command-line option: --log-dir <replaceable>path</replaceable></para> </entry> </row> @@ -852,7 +889,9 @@ generated by the script.</para> <para>Set this variable to a space-separated list, which is interpreted as a command and its options to precede the <userinput><command>make</command> <option>install</option></userinput> command used to install modules. This is useful for installing packages with &sudo; for example, but -please be careful while dealing with root privileges.</para></entry> +please be careful while dealing with root privileges.</para> +<para>Related command-line option: --make-install-prefix <replaceable>value</replaceable></para> +</entry> </row> <row id="conf-make-options"> @@ -870,6 +909,7 @@ build systems that use <command>ninja</command> for build (such as the <link linkend="conf-override-build-system"><application>Meson</application> build system</link>), see the <link linkend="conf-ninja-options">ninja-options</link> setting.</para> +<para>Related command-line option: --make-options <replaceable>value</replaceable></para> </entry> </row> @@ -934,6 +974,7 @@ options <replaceable>qtwebengine</replaceable> end options </programlisting> </note> +<para>Related command-line option: --ninja-options <replaceable>value</replaceable></para> </entry> </row> @@ -947,6 +988,7 @@ end options <para>If this option is set to true then &kdesrc-build; will not update the source code for the module automatically. It will still try to build the module if it normally would have tried anyways.</para> +<para>Related command-line option: <xref linkend="cmdline-no-src"/></para> </entry> </row> @@ -1002,6 +1044,7 @@ the auto-detection. In this case you can manually specify the correct build type </varlistentry> </variablelist> +<para>Related command-line option: --override-build-system <replaceable>value</replaceable></para> </entry> </row> @@ -1014,6 +1057,7 @@ the auto-detection. In this case you can manually specify the correct build type </simplelist> <para>This option controls whether old log directories are automatically deleted or not.</para> +<para>Related command-line option: --purge-old-logs, --no-purge-old-logs</para> </entry> </row> @@ -1030,6 +1074,7 @@ deleted or not.</para> <userinput>PREFIX=/path/to/qt</userinput> option to qmake to override where it installs the module. </para> +<para>Related command-line option: --qmake-options <replaceable>value</replaceable></para> </entry> </row> @@ -1043,6 +1088,7 @@ installs the module. If you do not specify this option, &kdesrc-build; will assume that &Qt; is provided by the operating system. </para> +<para>Related command-line option: --qt-install-dir <replaceable>path</replaceable></para> </entry> </row> @@ -1070,6 +1116,7 @@ installed. <para>Note that using this option can have a significant detrimental impact on both your bandwidth usage (if you use <replaceable>all</replaceable>) and the time taken to compile &kde; software, since &kdesrc-build; will be unable to perform incremental builds.</para> +<para>Related command-line option: --remove-after-install <replaceable>value</replaceable></para> </entry> </row> @@ -1099,6 +1146,7 @@ given, even if options like <link linkend="conf-branch">branch</link> are in effect. If the module is already at the given revision then it will not be updated further unless this option is changed or removed from the configuration.</para> +<para>Related command-line option: <xref linkend="cmdline-revision"/></para> </entry> </row> @@ -1113,7 +1161,9 @@ configuration.</para> built with support for running its test suite, and the test suite will be executed as part of the build process. &kdesrc-build; will show a simple report of the test results. This is useful for developers or those who want -to ensure their system is setup correctly.</para></entry> +to ensure their system is setup correctly.</para> +<para>Related command-line option: --run-tests, --no-run-tests</para> +</entry> </row> <row id="conf-set-env"> @@ -1146,6 +1196,7 @@ globally).</para> <para>This option is used to set the directory on your computer to store the &kde; &git; sources at. You may use the tilde (~) to represent the home directory if using this option.</para> +<para>Related command-line option: --source-dir <replaceable>path</replaceable></para> </entry> </row> @@ -1158,6 +1209,7 @@ to represent the home directory if using this option.</para> </simplelist> <para>Setting this option to <userinput>false</userinput> allows the script to continue execution after an error occurs during the build or install process.</para> +<para>Related command-line option: <xref linkend="cmdline-stop-on-failure"/></para> </entry> </row> @@ -1173,6 +1225,7 @@ after an error occurs during the build or install process.</para> want</emphasis> to use this option. &kde; releases are available in tarball form from the <ulink url="https://download.kde.org/";>&kde; download site</ulink>.</para> +<para>Related command-line option: --tag <replaceable>value</replaceable></para> </entry> </row> @@ -1192,6 +1245,7 @@ running <command>make install</command>.</para> files, &cmake; metadata, etc. that can cause issues in long-lived &kde; installations. However this only works on build systems that support <command>make uninstall</command>.</para> +<para>Related command-line option: --use-clean-install, --no-use-clean-install</para> </entry> </row> @@ -1301,6 +1355,7 @@ result in both <symbol>kde/kdegraphics/libs</symbol> and is compared).</para> <tip><para>See also <xref linkend="example-ignoring-a-module"/>.</para></tip> +<para>Related command-line option: <xref linkend="cmdline-ignore-modules"/></para> </entry> </row>
