Git commit 8c4c2c96c734a41185716c440ff9634bcdf7a5eb by Michael Pyne. Committed on 26/01/2014 at 05:11. Pushed by ashark into branch 'docbook_historied_per_file'.
doc: Correct docs for changes to arbitrary global cmdline flags. This was changed in the recent refactor, now the docs should be up-to-date. BUG:330387 Original commit: 2f52754d https://invent.kde.org/sdk/kdesrc-build/-/commit/2f52754d9547aeb283811fb0021497c972814622 M +13 -3 doc/cmdline/supported-cmdline-params.docbook M +3 -2 doc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/8c4c2c96c734a41185716c440ff9634bcdf7a5eb diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 19a94467..c5b53460 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -413,17 +413,27 @@ with it if it is needed.</para> </varlistentry> <varlistentry id="cmdline-global-option"> -<term><parameter>--<option-name>=</parameter></term> +<term><parameter>--<replaceable><option-name></replaceable>=</parameter></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 linkend="conf-log-dir">log-dir</link> option, you would do: <userinput><parameter>--log-dir=<filename class="directory"><replaceable>/path/to/dir</replaceable></filename></parameter></userinput>. -</para></listitem> +</para> + +<note><para>This feature can only be used for option names already recognized +by &kdesrc-build;, that are not already supported by relevant command line +options. For example the <link linkend="conf-async">async</link> configuration +file option has specific <link linkend="cmdline-async">--async</link> and <link +linkend="cmdline-no-async">--no-async</link> command line options that are +preferred by &kdesrc-build;. +</para></note> + +</listitem> </varlistentry> <varlistentry id="cmdline-module-option"> -<term><parameter>--<module-name>,<option-name>=</parameter></term> +<term><parameter>--set-module-value-option=<replaceable><module-name></replaceable>,<replaceable><option-name></replaceable>,<replaceable><option-value></replaceable></parameter></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. diff --git a/doc/index.docbook b/doc/index.docbook index 54285e39..a1c4a828 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -2,7 +2,7 @@ <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ <!-- Documentation for kdesrc-build. - Copyright (c) 2005-2008, 2010-2013 Michael Pyne <[email protected]> + Copyright (c) 2005-2008, 2010-2014 Michael Pyne <[email protected]> Copyright (c) 2005 Carlos Leonhard Woelz <[email protected]> Copyright (c) 2009 Burkhard Lück <[email protected]> @@ -130,6 +130,7 @@ <year>2011</year> <year>2012</year> <year>2013</year> +<year>2014</year> <holder>Michael Pyne</holder> </copyright> @@ -140,7 +141,7 @@ <legalnotice>&FDLNotice;</legalnotice> -<date>2013-02-19</date> +<date>2014-01-25</date> <releaseinfo>1.16</releaseinfo> <abstract>
