[sdk/kdesrc-build/docbook_historied_per_file] doc: Apply patch by Burkhard Lück to get rid of an outdated qt-copy example, clarify

Fri May 10 10:14:26 BST 2024

Git commit 34c637418995c824f55b04e3776ca64edea5cced by Michael Pyne.
Committed on 23/08/2010 at 01:06.
Pushed by ashark into branch 'docbook_historied_per_file'.

Apply patch by Burkhard Lück to get rid of an outdated qt-copy example, clarify
usage of module-base-path since qt-copy is no longer in Subversion, and change some
KDE 4.4's to 4.5 to get with the times. I will soon rename the docs in trunk to
reflect the name change of kdesvn-build to kdesrc-build as well.

CCMAIL:lueck at hube-lueck.de

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

Original commit: 9328f1c7
https://invent.kde.org/sdk/kdesrc-build/-/commit/9328f1c7c8bcfbc3a002e17a19178be21c8d4471

M  +0    -7    doc/features/features-overview.docbook
M  +2    -2    doc/kdesvn-buildrc/conf-options-table.docbook
M  +19   -20   doc/using-kdesvn-build/advanced-features.docbook

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

diff --git a/doc/features/features-overview.docbook b/doc/features/features-overview.docbook
index 6d91d9b0..a1d3cb2d 100644
--- a/doc/features/features-overview.docbook
+++ b/doc/features/features-overview.docbook
@@ -139,13 +139,6 @@ build</link> of a module directly from the command line, when you only need
 to update part of a module.
 </para></listitem>
 
-<listitem><para>
-&kdesvn-build; will automatically download and create the required <filename class="directory">/admin</filename>
-directory for a module if it is not downloaded from &subversion; the first time for
-some reason. This only applies to &kde; 3 modules, as /admin is not required
-for qt-copy or &kde; 4 modules.
-</para></listitem>
-
 <listitem><para>
 &kdesvn-build; will show the <link linkend="build-progress">progress of your
 build</link> when using &cmake;, and will always time the build
diff --git a/doc/kdesvn-buildrc/conf-options-table.docbook b/doc/kdesvn-buildrc/conf-options-table.docbook
index 6f88f42d..e765e52a 100644
--- a/doc/kdesvn-buildrc/conf-options-table.docbook
+++ b/doc/kdesvn-buildrc/conf-options-table.docbook
@@ -70,8 +70,8 @@ may use the tilde (~) for any paths you add using this option.</para>
 <entry>Overrides global</entry>
 <entry><para>Set this option to checkout from a branch of &kde; instead of the
 default of <replaceable>trunk</replaceable>, where &kde; development occurs.
-For instance, to checkout &kde; 4.4 branch, you would set this option to
-<replaceable>4.4</replaceable>.</para>
+For instance, to checkout &kde; 4.5 branch, you would set this option to
+<replaceable>4.5</replaceable>.</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-module-base-path">module-base-path</link> or <link
diff --git a/doc/using-kdesvn-build/advanced-features.docbook b/doc/using-kdesvn-build/advanced-features.docbook
index 0b35d3bf..77b153cc 100644
--- a/doc/using-kdesvn-build/advanced-features.docbook
+++ b/doc/using-kdesvn-build/advanced-features.docbook
@@ -21,7 +21,7 @@ option for a module, which will specify a list of directories to download.
 <tip><para>
 If you do not already know what to download from a module, it may be a good idea
 to browse the &subversion; layout for a module first, using
-<ulink url="http://websvn.kde.org/branches/KDE/4.4/">WebSVN</ulink>.
+<ulink url="http://websvn.kde.org/branches/KDE/4.5/">WebSVN</ulink>.
 </para></tip>
 
 <informalexample>
@@ -136,21 +136,21 @@ and &kdesvn-build; will try to determine the appropriate location within the
 well.</para>
 
 <informalexample>
-<para>To download kdelibs from &kde; 4.4 (which is simply known as the 4.4 branch):
+<para>To download kdelibs from &kde; 4.5 (which is simply known as the 4.5 branch):
 </para>
 
 <screen>
 module kdelibs
-  branch <replaceable>4.4</replaceable>
+  branch <replaceable>4.5</replaceable>
   # other options...
 end module
 </screen>
 
-<para>Or, to download kdemultimedia as it was released with &kde; 4.4.3:</para>
+<para>Or, to download kdemultimedia as it was released with &kde; 4.5.1:</para>
 
 <screen>
 module kdemultimedia
-  tag <replaceable>4.4.3</replaceable>
+  tag <replaceable>4.5.1</replaceable>
   # other options...
 end module
 </screen>
@@ -180,32 +180,31 @@ can figure out the appropriate middle part by itself. When it cannot, you can us
 
 <informalexample>
 <screen>
-module qt-copy
-  # branch does not work here yet
-  module-base-path branches/qt/4.4
+module kdesupport
+    # kdesupport supports various tags to easily organize the required
+    # software for a given KDE Platform release.
+    module-base-path tags/kdesupport-for-4.5
 end module
 </screen>
 
-<para>This would cause &kdesvn-build; to download qt-copy from (in this example),
-<filename>svn://anonsvn.kde.org/home/kde/<replaceable>branches/qt/4.4</replaceable>/qt-copy</filename>.
+<para>This would cause &kdesvn-build; to download kdesupport from (in this example),
+<filename>svn://anonsvn.kde.org/home/kde/<replaceable>tags/kdesupport-for-4.5</replaceable></filename>.
 </para>
 </informalexample>
+<tip><para>In previous versions of &kdesvn-build;, the &module-base-path; was
+handled differently. If you encounter trouble using an old module-base-path
+definition perhaps you should verify that the actual path is as &kdesvn-build;
+expects by using the <link linkend="cmdline-pretend">--pretend</link> option.
+</para></tip>
 </listitem>
 
 <listitem><para>The &override-url; option, on the other hand, requires you to
 specify the exact path to download from. However, this allows you to pull from
-paths that &kdesvn-build; would have no hope of downloading from.
+paths that previous versions of &kdesvn-build; would have no hope of downloading from.
+Currently, the &module-base-path; option should be sufficient for any Subversion
+source URL.
 </para>
 
-<informalexample>
-<screen>
-module qt-copy
-  # Specify exact path to grab.
-  override-url svn://anonsvn.kde.org/home/kde/branches/qt/4.4/qt-copy
-end module
-</screen>
-</informalexample>
-
 <important><para>
 &kdesvn-build; will not touch or correct the value you specify for &override-url;
 at all, so if you change your &svn-server; setting, you may need to update this

