Git commit 219908425b341589dc901d7158b7a687e0d121ef by Andrew Shark. Committed on 20/02/2024 at 21:29. Pushed by ashark into branch 'docbook_historied_per_file'.
doc: List --run in commonly used options Reference full documentation from --help. No need to keep yet another place of options listing. Original commit: 19044150 https://invent.kde.org/sdk/kdesrc-build/-/commit/19044150a44a2f7a18d89a1e74dbcc0b5f696c6e M +54 -42 doc/cmdline/cmdline-usage.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/219908425b341589dc901d7158b7a687e0d121ef diff --git a/doc/cmdline/cmdline-usage.docbook b/doc/cmdline/cmdline-usage.docbook index 3bad3988..e0110ce9 100644 --- a/doc/cmdline/cmdline-usage.docbook +++ b/doc/cmdline/cmdline-usage.docbook @@ -14,48 +14,6 @@ kdesrc-build will build all modules defined in its configuration file, in the order listed in that file (although this can be modified by various configuration file options).</para> -<sect2 id="cmdline-usage-options"> -<title>Commonly used command line options</title> - -<para>The full list of command line options is given in <xref -linkend="supported-cmdline-params"/>. The most-commonly used options -include:</para> - -<variablelist> - <varlistentry> - <term><option>--pretend</option> (or <option>-p</option>)</term> - <listitem><para>This option causes &kdesrc-build; to indicate what actions - it would take, without actually really implementing them. This can be - useful to make sure that the modules you think you are building will - actually get built.</para></listitem> - </varlistentry> - - <varlistentry> - <term><option>--refresh-build</option></term> - <listitem><para>This option forces &kdesrc-build; to build the given - modules from an absolutely fresh start point. Any existing build directory - for that module is removed and it is rebuilt. This option is useful if you - have errors building a module, and sometimes is required when &Qt; or &kde; - libraries change.</para></listitem> - </varlistentry> - - <varlistentry> - <term><option>--no-src</option></term> - <listitem><para>This option skips the source update process. You might use - it if you have very recently updated the source code (perhaps you did it - manually or recently ran &kdesrc-build;) but still want to rebuild some - modules.</para></listitem> - </varlistentry> - - <varlistentry> - <term><option>--no-build</option></term> - <listitem><para>This option is similar to <option>--no-src</option> above, - but this time the build process is skipped.</para></listitem> - </varlistentry> -</variablelist> - -</sect2> - <sect2 id="cmdline-usage-modules"> <title>Specifying modules to build</title> @@ -93,4 +51,58 @@ option before building a new module set to ensure it is only building the modules you want.</para> </sect2> + +<sect2 id="cmdline-commonly-used-options"> + <title>Commonly used command line options</title> + + <variablelist> + <varlistentry> + <term><option>--pretend</option> (or <option>-p</option>)</term> + <listitem><para>This option causes &kdesrc-build; to indicate what actions + it would take, without actually really implementing them. This can be + useful to make sure that the modules you think you are building will + actually get built.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--no-src</option></term> + <listitem><para>This option skips the source update process. You might use + it if you have very recently updated the source code (perhaps you did it + manually or recently ran &kdesrc-build;) but still want to rebuild some + modules.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--no-include-dependencies</option> (or <option>-D</option>)</term> + <listitem><para>Only process the selected modules, skipping their dependencies. + Useful when you have changed only selected modules, and you are sure you + do not need to rebuild the others.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--refresh-build</option> (or <option>-r</option>)</term> + <listitem><para>This option forces &kdesrc-build; to build the given + modules from an absolutely fresh start point. Any existing build directory + for that module is removed and it is rebuilt. This option is useful if you + have errors building a module, and sometimes is required when &Qt; or &kde; + libraries change.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--resume-from</option> module</term> + <listitem><para>Skips modules until just before the given module, then operates as normal. + Useful when the previous build failed on specific module, you fixed it, and then you + want to continue the with building the rest of initial set of modules.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--run</option> module</term> + <listitem><para>Launch the built application.</para></listitem> + </varlistentry> + </variablelist> + + <para>The full list of command line options is given in <xref + linkend="supported-cmdline-params"/>.</para> + + </sect2> </sect1>