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
wilder
Michael Pyne 12 years ago
parent 2b49970305
commit 2f52754d95
  1. 21
      doc/index.docbook
  2. 10
      doc/man-kdesrc-build.1.docbook
  3. 11
      modules/ksb/Application.pm

@ -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 <mpyne@kde.org>
Copyright (c) 2005-2008, 2010-2014 Michael Pyne <mpyne@kde.org>
Copyright (c) 2005 Carlos Leonhard Woelz <carloswoelz@imap-mail.com>
Copyright (c) 2009 Burkhard Lück <lueck@hube-lueck.de>
@ -98,6 +98,7 @@
<year>2011</year>
<year>2012</year>
<year>2013</year>
<year>2014</year>
<holder>Michael Pyne</holder>
</copyright>
@ -108,7 +109,7 @@
<legalnotice>&FDLNotice;</legalnotice>
<date>2013-02-19</date>
<date>2014-01-25</date>
<releaseinfo>1.16</releaseinfo>
<abstract>
@ -3109,17 +3110,27 @@ with it if it is needed.</para>
</varlistentry>
<varlistentry id="cmdline-global-option">
<term><parameter>--&lt;option-name&gt;=</parameter></term>
<term><parameter>--<replaceable>&lt;option-name&gt;</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>--&lt;module-name&gt;,&lt;option-name&gt;=</parameter></term>
<term><parameter>--set-module-value-option=<replaceable>&lt;module-name&gt;</replaceable>,<replaceable>&lt;option-name&gt;</replaceable>,<replaceable>&lt;option-value&gt;</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.

@ -5,7 +5,7 @@
<!--
Man page for kdesrc-build.
Copyright (c) 2011 Michael Pyne <mpyne@kde.org>
Copyright (c) 2011, 2014 Michael Pyne <mpyne@kde.org>
Permission is granted to copy, distribute and/or modify this document under
the terms of the GNU Free Documentation License, Version 1.2 or any later
@ -22,7 +22,7 @@
<email>mpyne@kde.org</email>
<personblurb><para>Authored man page</para></personblurb>
</author>
<date>2013-02-19</date>
<date>2014-01-25</date>
</refentryinfo>
<refmeta>
@ -618,7 +618,7 @@ combining short options into one at this point. (E.g. running
<varlistentry>
<term>
<option>--<replaceable>module</replaceable>,<replaceable>foo</replaceable>=<replaceable>bar</replaceable></option>
<option>--set-module-option-value=<replaceable>module</replaceable>,<replaceable>foo</replaceable>,<replaceable>bar</replaceable></option>
</term>
<listitem>
@ -627,6 +627,8 @@ combining short options into one at this point. (E.g. running
<option>bar</option> for the module <option>module</option>. This does not
work for module sets yet, you must repeat this for each module you want to
be affected. (Of course, you could simply edit your configuration file...)
This option worked slightly differently prior to version 1.16.
</para>
</listitem>
</varlistentry>
@ -981,7 +983,7 @@ url="http://kdesrc-build.kde.org/documentation/">http://kdesrc-build.kde.org/doc
<refsect1>
<title>COPYING</title>
<para>Copyright (C) 2003-2013 Michael Pyne.</para>
<para>Copyright (C) 2003-2014 Michael Pyne.</para>
<para>This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free

@ -2679,10 +2679,13 @@ Options:
--build-system-only Create the build infrastructure, but don't actually
perform the build.
--<option>= Any unrecognized options are added to the global
configuration, overriding any value that may exist.
--<module>,<option>= Likewise, this allows you to override any module
specific option from the command line.
--<option>= Any unrecognized options override an existing global
configuration value, if present.
--set-module-option-value=<module>,<option>,<value>
This option allows you to override an option for a given module, so
that you don't have to change it in the configuration file temporarily.
Use a module name of 'global' for the global configuration.
--pretend (or -p) Don't actually contact the source server, run make,
or create/delete files and directories. Instead,

Loading…
Cancel
Save