[sdk/kdesrc-build/docbook_historied_per_file] doc: Some touchups to the kdesvn-build documentation.

Michael Pyne null at kde.org
Fri May 10 10:14:26 BST 2024


Git commit 6a568759b694f650bd83e15e6fda9e281bcb289f by Michael Pyne.
Committed on 15/01/2008 at 03:43.
Pushed by ashark into branch 'docbook_historied_per_file'.

Some touchups to the kdesvn-build documentation.

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

Original commit: 5087dbc4
https://invent.kde.org/sdk/kdesrc-build/-/commit/5087dbc4ef7ae60c88b503e0479e575e7cce97b0

M  +6    -0    doc/features/features-overview.docbook
M  +3    -2    doc/getting-started/before-building.docbook
M  +7    -0    doc/getting-started/index.docbook
M  +3    -2    doc/index.docbook
M  +13   -1    doc/kdesvn-buildrc/index.docbook

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

diff --git a/doc/features/features-overview.docbook b/doc/features/features-overview.docbook
index 5c47b7d5..51245bf7 100644
--- a/doc/features/features-overview.docbook
+++ b/doc/features/features-overview.docbook
@@ -31,6 +31,12 @@ use on your computer.
 anonymous &subversion; servers.</para>
 </listitem>
 
+<listitem><para>
+Another speedup is provided by starting the build process for a module as soon
+as the source code for that module has been downloaded.  (Available since
+version 1.6)
+</para></listitem>
+
 <listitem><para>
 Has excellent support for the <link linkend="using-qt-copy">qt-copy module</link>,
 including optionally applying bugfix and optimization patches to the qt-copy
diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook
index 8ef9df41..3a151cc0 100644
--- a/doc/getting-started/before-building.docbook
+++ b/doc/getting-started/before-building.docbook
@@ -29,7 +29,8 @@ in order to prepare and use the system installation correctly.
 strategy) you must install the development tools and libraries needed for &kde;.
 The complete list of required tools can be found from the
 <ulink url="http://www.kde.org/info/requirements/3.5.php">&kde; Compilation
-Requirements</ulink> page.
+Requirements</ulink> page. Requirements for the &kde; 4 series may be obtained
+from the <ulink url="http://techbase.kde.org/">KDE TechBase</ulink>.
 </para>
 
 <para>Here is a list of some of the things you will need:</para>
@@ -39,7 +40,7 @@ Requirements</ulink> page.
 
 <listitem><para>&autoconf; version 2.57, or higher. (&kde; 3 only)</para></listitem>
 
-<listitem><para>&cmake; 2.4.5, or higher.</para></listitem>
+<listitem><para>&cmake; 2.4.7, or higher.</para></listitem>
 
 <listitem><para>The &subversion; client program, including support for Secure
 HTTP (https). To ensure needed support, you can run
diff --git a/doc/getting-started/index.docbook b/doc/getting-started/index.docbook
index 67dc943f..a40d5328 100644
--- a/doc/getting-started/index.docbook
+++ b/doc/getting-started/index.docbook
@@ -18,6 +18,13 @@ about packaging tools and requirements, common compilation pitfalls and
 strategies and information about running your new &kde; installation.
 </para>
 
+<para>
+In addition, the <ulink url="http://techbase.kde.org/">&kde; TechBase</ulink>
+wiki maintains a procedure for <ulink
+url="http://techbase.kde.org/index.php?title=Getting_Started/Build/KDE4">building
+&kde; from source code</ulink>.
+</para>
+
 &before-building;
 
 &configure-data;
diff --git a/doc/index.docbook b/doc/index.docbook
index fb25393a..6fde3060 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -100,6 +100,7 @@
 <copyright>
 <year>2006</year>
 <year>2007</year>
+<year>2008</year>
 <holder>Michael Pyne</holder>
 </copyright>
 
@@ -111,8 +112,8 @@
 
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2007-05-01</date>
-<releaseinfo>1.4</releaseinfo>
+<date>2008-01-14</date>
+<releaseinfo>1.6</releaseinfo>
 
 <abstract>
 <para>&kdesvn-build; is a script which builds and installs &kde; directly from the sources found in the &kde; &subversion; repository.</para>
diff --git a/doc/kdesvn-buildrc/index.docbook b/doc/kdesvn-buildrc/index.docbook
index 915fac8c..83e3f66e 100644
--- a/doc/kdesvn-buildrc/index.docbook
+++ b/doc/kdesvn-buildrc/index.docbook
@@ -271,7 +271,11 @@ set the environment variable <envar>CXXFLAGS</envar> during the build process.
 <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.
+extragear-network using this option.  Note that although this changes the
+name of the module on disk, it is not a good idea to include directories
+or directory separators in the name as this will interfere with any
+<link linkend="conf-build-dir">build-dir</link> or
+<link linkend="conf-source-dir">source-dir</link> options.
 </entry>
 </row>
 
@@ -487,6 +491,14 @@ lower a priority &kdesvn-build; will set for itself. The default is 10.
 </entry>
 </row>
 
+<row id="conf-no-svn">
+<entry>no-svn</entry>
+<entry>Overrides global</entry>
+<entry>If this option is set to true then &kdesvn-build; will not update the
+source code for the module automatically.  It will still try to build the
+module if it normally would have tried anyways.</entry>
+</row>
+
 <row id="conf-no-rebuild-on-fail">
 <entry>no-rebuild-on-fail</entry>
 <entry>Overrides global</entry>



More information about the kde-doc-english mailing list