[sdk/kdesrc-build/docbook_historied_per_file] doc: Add three new config file options to kdesvn-build.

[Michael Pyne]

Git commit cceafffea45f77254e4af96bf3f59365211b0e46 by Michael Pyne.
Committed on 09/06/2005 at 02:34.
Pushed by ashark into branch 'docbook_historied_per_file'.

Add three new config file options to kdesvn-build.
1. branch, to build the module from a given branch.
2. tag, to build the module from a tag (BUT DON'T USE THIS, use Konstruct or a
        tarball).
3. override-url, for when it turns out that I wasn't smart enough, you can
                 tell kdesvn-build exactly where to find what you want.

Also, update the man page information, and update the documentation to be in
sync with /trunk.

svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=423616

Original commit: c34b4f20
https://invent.kde.org/sdk/kdesrc-build/-/commit/c34b4f2064d8e036b89b4fc8e7c59a77a5a9e3d1

M  +2    -2    doc/index.docbook
M  +41   -0    doc/kdesvn-buildrc/index.docbook [INFRASTRUCTURE]

https://invent.kde.org/sdk/kdesrc-build/-/commit/cceafffea45f77254e4af96bf3f59365211b0e46

diff --git a/doc/index.docbook b/doc/index.docbook
index 0647ffda..6ca7fa42 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -51,8 +51,8 @@
 
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2005-05-15</date>
-<releaseinfo>0.94</releaseinfo>
+<date>2005-06-18</date>
+<releaseinfo>0.97</releaseinfo>
 
 <abstract>
 <para>The &kdesvn-build; is a Perl script which builds and installs &kde; directly from the sources found in the &kde; &svn; repository.</para>
diff --git a/doc/kdesvn-buildrc/index.docbook b/doc/kdesvn-buildrc/index.docbook
index ddf6f40a..47ecfa06 100644
--- a/doc/kdesvn-buildrc/index.docbook
+++ b/doc/kdesvn-buildrc/index.docbook
@@ -48,6 +48,7 @@ authors using the address you can find <link linkend="authors">above</link>.
 <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-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>
 <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>
@@ -129,6 +130,21 @@ may use the tilde (~) for any paths you add using this option.</para>
 </entry>
 </row>
 
+<row id="conf-branch">
+<entry>branch</entry>
+<entry>Overrides global</entry>
+<entry><para>Set this option to checkout from a branch of KDE instead of the
+default of "trunk", where KDE development occurs.  For instance, to checkout
+KDE 3.4 branch, you would set this option to "3.4".</para>
+<para>Note that some modules use a different branch name.  Notably, the
+required arts module doesn't go by KDE version numbers.  The arts that
+accompanied KDE 3.4 was version 1.4.</para>
+<para>If kdesvn-build fails to properly download a branch with this option, you
+may have to manually specify the URL to download from using the <link
+linkend="conf-override-url">override-url</link> option.</para>
+</entry>
+</row>
+
 <row id="conf-build-dir">
 <entry>build-dir</entry>
 <entry>Overrides global</entry>
@@ -359,6 +375,16 @@ 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-override-url">
+<entry>override-url</entry>
+<entry>Overrides global</entry>
+<entry>If you set this option, kdesvn-build will use its value as the URL
+to pass to Subversion <emphasis>completely unchanged</emphasis>.  You should
+generally use this if you want to download a specific release but kdesvn-build
+can't figure out what you mean using <link linkend="conf-branch">branch</link>.
+</entry>
+</row>
+
 <row id="conf-qtdir">
 <entry>qtdir</entry>
 <entry>Can't be overridden</entry>
@@ -412,6 +438,21 @@ by default.
 </entry>
 </row>
 
+<row id="conf-tag">
+<entry>tag</entry>
+<entry>Overrides global</entry>
+<entry><para>Use this option to download a specific release of a module.</para>
+<para><emphasis>NOTE:</emphasis> The odds are very good that you DO NOT WANT
+to use this option. KDE releases are available in tarball form from <ulink
+url="ftp://ftp.kde.org/">The KDE FTP site</ulink> or one of <ulink
+url="http://download.kde.org/download.php">its mirrors</ulink>.</para>
+<para>If you are using kdesvn-build because you have having trouble getting
+a KDE release to build on your distribution, consider using the <ulink
+url="http://developer.kde.org/build/konstruct/">Konstruct build tool</ulink>
+instead, which works from the release tarballs.</para>
+</entry>
+</row>
+
 <row id="conf-use-qt-builddir-hack">
 <entry>use-qt-builddir-hack</entry>
 <entry>Overrides global</entry>