just to implement some command line options, so there's no need to
document them in a user manual.
svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=414876
<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-binpath">binpath</link>, to set the <envar>PATH</envar> variable.</para></listitem>
<listitem><para><link linkend="conf-build-dir">build-dir</link>, to set the directory to build in.</para></listitem>
<listitem><para><link linkend="conf-checkout-only">checkout-only</link>, to checkout only parts of a module.</para></listitem>
<listitem><para><link linkend="conf-colorful-output">colorful-output</link> to add color to the script output.</para></listitem>
<listitem><para><link linkend="conf-configure-flags">configure-flags</link> to define what flags to configure a module with.</para></listitem>
<listitem><para><link linkend="conf-cxxflags">cxxflags</link> to define the <envar>CXXFLAGS</envar> variable.</para></listitem>
<listitem><para><link linkend="conf-dest-dir">dest-dir</link> to change the directory name for a module.</para></listitem>
<listitem><para><link linkend="conf-do-not-compile">do-not-compile</link>, to mark directories to skip building.</para></listitem>
<listitem><para><link linkend="conf-inst-apps">inst-apps</link>, to only build and install some directories.</para></listitem>
<listitem><para><link linkend="conf-install-after-build">install-after-build</link>, to avoid installing after the build process.</para></listitem>
<listitem><para><link linkend="conf-kdedir">kdedir</link>, to set the directory to install KDE to.</para></listitem>
<listitem><para><link linkend="conf-libpath">libpath</link>, to set the <envar>LD_LIBRARY_PATH</envar> variable.</para></listitem>
<listitem><para><link linkend="conf-make-install-prefix">make-install-prefix</link>, to run a helper program (like sudo) during make install.</para></listitem>
<listitem><para><link linkend="conf-make-options">make-options</link>, to pass options to the make program.</para></listitem>
<listitem><para><link linkend="conf-manual-build">manual-build</link>, to avoid building the module automatically.</para></listitem>
<listitem><para><link linkend="conf-manual-update">manual-update</link>, to avoid doing anything to the module automatically.</para></listitem>
<listitem><para><link linkend="conf-module-base-path">module-base-path</link>, to change where to download the module from (useful for branches and tags).</para></listitem>
<listitem><para><link linkend="conf-niceness">niceness</link>, to change the CPU priority.</para></listitem>
<listitem><para><link linkend="conf-no-rebuild-on-fail">no-rebuild-on-fail</link>, to avoid running make again if it fails.</para></listitem>
<listitem><para><link linkend="conf-qtdir">qtdir</link>, to set the path to Qt.</para></listitem>
<listitem><para><link linkend="conf-set-env">set-env</link>, to set an environment variable.</para></listitem>
<listitem><para><link linkend="conf-source-dir">source-dir</link>, to change where to download the source code to.</para></listitem>
<listitem><para><link linkend="conf-stop-on-failure">stop-on-failure</link>, to make kdesvn-build stop as soon as a failure is encountered.</para></listitem>
<listitem><para><link linkend="conf-svn-server">svn-server</link>, to change the server the sources are downloaded from.</para></listitem>
<listitem><para><link linkend="conf-use-qt-builddir-hack">use-qt-builddir-hack</link>, to give Qt a separate build directory from its source like KDE.</para></listitem>
<listitem><para><link linkend="conf-use-unsermake">use-unsermake</link>, to use the advanced unsermake build system.</para></listitem>
</itemizedlist>
</para>
@ -325,19 +317,6 @@ Perhaps surprisingly, this option can be changed per module.
</entry>
</row>
<row id="conf-build-system-only">
<entry>build-system-only</entry>
<entry>Overrides global</entry>
<entry>Set this option to only create the build system for this module. What that
means is that the <command>make <option>-f</option> Makefile.cvs</command> command will be run, and
the configure script will be created and run, and make will not be run.
This option is exactly equivalent to the <link
linkend="cmdline-build-system-only"><option>--build-system-only</option></link> command line option.
This command is useful for checking what configure-flags each module supports
so you can change your ~/.kdesvn-buildrc.
</entry>
</row>
<row id="conf-checkout-only">
<entry>checkout-only</entry>
<entry>Overrides global</entry>
@ -382,23 +361,12 @@ set the environment variable <envar>CXXFLAGS</envar> during the build process.
</entry>
</row>
<row id="conf-debug">
<entry>debug</entry>
<entry>Can't be overridden</entry>
<entry>This option enables the script's debug mode. At this point, all this
switch does is disable logging to files, instead dumping all output to
stdout. You should use the <link linkend="cmdline-debug"><option>--debug</option></link> command line
option instead, this option only exists to implement it internally.
</entry>
</row>
<row id="conf-disable-build-list">
<entry>disable-build-list</entry>
<entry>Can't be overridden</entry>
<entry>Normally &kdesvn-build; will write out the list of modules that were
successfully built to a file under the source directory called
<filename class="directory">successfully-built</filename>. If you set this option to 0,
&kdesvn-build; will skip writing out the file.
<row id="conf-dest-dir">
<entry>dest-dir</entry>
<entry>Overrides global</entry>
<entry>Use this option to change the name a module is given on disk. For
example, if your module was extragear/network, you could rename it to
extragear-network using this option.
</entry>
</row>
@ -468,17 +436,6 @@ added. You may use the tilde (~) for any paths you add using this option.
</entry>
</row>
<row id="conf-lockfile">
<entry>lockfile</entry>
<entry>Can't be overridden</entry>
<entry>
<para>The path of a file to use for script locking, to prevent parallel execution.
If you don't specify this value, the default is <filename class="directory">~/.kdesvn-lock</filename></para>
<para>If the script is unable to create this file, it will abort.</para>
</entry>
</row>
<row id="conf-log-dir">
<entry>log-dir</entry>
<entry>Overrides global</entry>
@ -562,24 +519,6 @@ to rebuild this module if it should fail an incremental build. Normally
effect of a stray &svn; update messing up the build system.</entry>
</row>
<row id="conf-no-svn">
<entry>no-svn</entry>
<entry>Overrides global</entry>
<entry>Set this option value to <quote>true</quote> to prevent &svn; updates for the module.
This option is exactly equivalent to the <link linkend="cmdline-no-svn"><option>--no-svn</option></link>
command line option.
</entry>
</row>
<row id="conf-pretend">
<entry>pretend</entry>
<entry>Can't be overridden</entry>
<entry>Set the option value to <quote>true</quote> in order to <quote>fake</quote> the update/build or
install process. This setting results in verbose output, and is exactly
equivalent to the <link linkend="cmdline-pretend"><option>--pretend</option></link> command line option.
</entry>
</row>
<row id="conf-qtdir">
<entry>qtdir</entry>
<entry>Can't be overridden</entry>
@ -592,36 +531,6 @@ You may use a tilde (~) to represent your home directory.
</entry>
</row>
<row id="conf-recreate-configure">
<entry>recreate-configure</entry>
<entry>Overrides global</entry>
<entry>Use this option to re-run <command>make <option>-f</option> Makefile.cvs</command> and then reconfigure the
module before building. Note that setting this option in the configuration
file isn't a great idea, use <link
linkend="cmdline-recreate-configure"><option>--recreate-configure</option></link> on the command line
instead.
</entry>
</row>
<row id="conf-reconfigure">
<entry>reconfigure</entry>
<entry>Overrides global</entry>
<entry>Use this option to reconfigure the module before building. Note that
setting this option in the configuration file isn't a great idea, use
<link linkend="cmdline-reconfigure"><option>--reconfigure</option></link> on the command line instead.
</entry>
</row>
<row id="conf-refresh-build">
<entry>refresh-build</entry>
<entry>Overrides global</entry>
<entry>Set this option value to <quote>true</quote> to cause the build system for this module
to start from scratch every time the script is run. This option is exactly
equivalent to the <link linkend="cmdline-refresh-build"><option>--refresh-build</option></link> command
Michael Pyne
21 years ago