Git commit e4817d5844300c26434d90d0c07f0a57938ee3f8 by Michael Pyne. Committed on 13/11/2007 at 03:21. Pushed by ashark into branch 'docbook_historied_per_file'.
Add documentation for the async option. svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=735933 Original commit: 15dc9b63 https://invent.kde.org/sdk/kdesrc-build/-/commit/15dc9b63e5d21421aed0ce2871c012190792dd84 M +20 -0 doc/cmdline/index.docbook M +11 -0 doc/kdesvn-buildrc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/e4817d5844300c26434d90d0c07f0a57938ee3f8 diff --git a/doc/cmdline/index.docbook b/doc/cmdline/index.docbook index 469a0032..0c964a8d 100644 --- a/doc/cmdline/index.docbook +++ b/doc/cmdline/index.docbook @@ -13,6 +13,15 @@ The script accepts the following command-line options: <variablelist> +<varlistentry id="cmdline-async"> +<term><option>--async</option></term> +<listitem><para> +Enables the <link linkend="conf-async">asynchronous mode</link> to update and build +at the same time. This is the default, this option only needs specified if you +have disabled it in the configuration. +</para></listitem> +</varlistentry> + <varlistentry id="cmdline-help"> <term><option>--help</option></term> <listitem><para> @@ -50,6 +59,17 @@ of this run. <replaceable>value</replaceable> should be between 0 and 20. </para></listitem> </varlistentry> +<varlistentry id="cmdline-no-async"> +<term><option>--no-async</option></term> +<listitem><para> +Disables the <link linkend="conf-async">asynchronous mode</link> of updating. +Instead the update will be performed in its entirety before the build starts. +This option will slow down the overall process, but if you encounter IPC errors +while running &kdesvn-build; try using this option, and submitting a +<ulink url="http://bugs.kde.org/";>bug report</ulink>. +</para></listitem> +</varlistentry> + <varlistentry id="cmdline-no-color"> <term><option>--no-color</option></term> <listitem><para> diff --git a/doc/kdesvn-buildrc/index.docbook b/doc/kdesvn-buildrc/index.docbook index 7a261d83..915fac8c 100644 --- a/doc/kdesvn-buildrc/index.docbook +++ b/doc/kdesvn-buildrc/index.docbook @@ -45,6 +45,7 @@ authors using the address you can find <link linkend="authors">above</link>. <itemizedlist> <listitem><para><link linkend="conf-apidox">apidox</link>, to build API Documentation.</para></listitem> <listitem><para><link linkend="conf-apply-qt-patches">apply-qt-patches</link>, to enhance qt-copy.</para></listitem> +<listitem><para><link linkend="conf-async">async</link>, to update and build at the same time.</para></listitem> <listitem><para><link linkend="conf-binpath">binpath</link>, to set the <envar>PATH</envar> variable.</para></listitem> <listitem><para><link linkend="conf-branch">branch</link>, to checkout from a branch instead of /trunk.</para></listitem> <listitem><para><link linkend="conf-build-dir">build-dir</link>, to set the directory to build in.</para></listitem> @@ -124,6 +125,16 @@ are normally the reason for using qt-copy instead of a stock &Qt;, it should not do any harm to enable it. The default is to enable the patches.</entry> </row> +<row id="conf-async"> +<entry>async</entry> +<entry>Cannot be overridden</entry> +<entry><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. This option defaults +to enabling asynchronous mode. To disable, set this option to <replaceable>false</replaceable></para> +<para>This option is available since the 1.7 release.</para></entry> +</row> + <row id="conf-binpath"> <entry>binpath</entry> <entry>Overrides global</entry>
