[sdk/kdesrc-build/docbook_historied_per_file] doc: More updates to the kdesrc-build documentation provided by Burkhard Lück, as well

Michael Pyne null at kde.org
Fri May 10 10:15:11 BST 2024


Git commit 1b4f9f5817cf47b8af715269e2239dc492e27370 by Michael Pyne.
Committed on 27/08/2010 at 00:03.
Pushed by ashark into branch 'docbook_historied_per_file'.

More updates to the kdesrc-build documentation provided by Burkhard Lück, as well
as a very few updates of my own.

CCMAIL:lueck at hube-lueck.de

svn path=/trunk/KDE/kdesdk/doc/scripts/kdesrc-build/; revision=1168555

Original commit: efc818e2
https://invent.kde.org/sdk/kdesrc-build/-/commit/efc818e2167a343a862e4d8aace1f3ce7fc41bd7

M  +5    -5    doc/getting-started/configure-data.docbook
M  +14   -7    doc/using-kdesrc-build/advanced-features.docbook

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

diff --git a/doc/getting-started/configure-data.docbook b/doc/getting-started/configure-data.docbook
index f4af206e..30b542d8 100644
--- a/doc/getting-started/configure-data.docbook
+++ b/doc/getting-started/configure-data.docbook
@@ -33,12 +33,12 @@ destination directory that &kde; is installed to. This defaults to
 <filename class="directory">~/kde</filename>, which is a single-user installation.</para></listitem>
 
 <listitem><para><link linkend="conf-qtdir">qtdir</link>, which controls the
-path to the installation of &Qt; to use. The defaults to using the qt-copy
-module from the &kde; &subversion; repository
-(<filename class="directory">~/kdesvn/build/qt-copy</filename>).</para>
+path to the installation of &Qt; to use. The default is to use a &Qt; compiled
+by &kdesrc-build;, using the special qt-copy module and the latest available
+source code.
+(<filename class="directory">~/kdesrc/build/qt-copy</filename>).</para>
 
-<para>For Qt versions that support installation, this also controls where to
-install qt-copy.</para></listitem>
+<para>This also controls where to install qt-copy.</para></listitem>
 
 <listitem><para><link linkend="conf-svn-server">svn-server</link>, which
 selects what &url; to download the sources from. This is useful if you are a
diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook
index 13b5e8b7..62f83949 100644
--- a/doc/using-kdesrc-build/advanced-features.docbook
+++ b/doc/using-kdesrc-build/advanced-features.docbook
@@ -25,12 +25,12 @@ to browse the &subversion; layout for a module first, using
 </para></tip>
 
 <informalexample>
-<para>To only grab &kuser; and &kdat; from kdeadmin, you could use &checkout-only;
-like this:</para>
+<para>To only grab &kuser; and <application>KSystemLog</application> from
+kdeadmin, you could use &checkout-only; like this:</para>
 
 <screen>
 module <replaceable>kdeadmin</replaceable>
-  &checkout-only; <replaceable>kuser kdat</replaceable>
+  &checkout-only; <replaceable>kuser ksystemlog</replaceable>
 end module
 </screen>
 
@@ -43,7 +43,9 @@ line, and that the required dependency goes before the directory that needs it.<
 
 <para>Also, sometimes an application may need other directories and it is hard
 to figure out what they are, which may require some trial and error of constantly
-adding directories to the option to figure out.</para>
+adding directories to the option to figure out. This option depends on support
+from the build system of the module, so it is only useful for modules that are
+collections of individual applications.</para>
 </important>
 
 <para>One final note to make about this option: If you change the value of this
@@ -70,22 +72,27 @@ directories that should not be compiled.</para>
 
 <important><para>
 Also like &checkout-only;, this option requires at least that the
-<command>configure</command> script is run again for the module after changing
+build system for the module is reconfigured after changing
 it. This is done using the <userinput><command>kdesrc-build</command>
 <option>&cmd-reconfigure;</option>
 <option><replaceable>module</replaceable></option></userinput> command.
 </para></important>
 
 <informalexample>
-<para>To remove the <filename>dcoppython</filename> directory from the kdebindings build process:</para>
+<para>To remove the <filename class="directory">python</filename> directory
+from the kdebindings build process:</para>
 
 <screen>
 module <replaceable>kdebindings</replaceable>
-  &do-not-compile; <replaceable>dcoppython</replaceable>
+  &do-not-compile; <replaceable>python</replaceable>
 end module
 </screen>
+
 </informalexample>
 
+<note><para>This function depends on some standard conventions used in most
+&kde; modules. Therefore it may not work for all programs.</para></note>
+
 </sect3>
 
 </sect2>



More information about the kde-doc-english mailing list