[sdk/kdesrc-build/docbook_historied_per_file] doc: Merge remote-tracking branch 'verahawk/xdg_spec'

Michael Pyne <[email protected]>
Newsgroups gmane.comp.kde.cvs,gmane.comp.kde.doc
Message-ID <[email protected]>
Git commit 0b70fc7f85f802eed164e434ee3db39db546c37d by Michael Pyne.
Committed on 22/01/2022 at 23:35.
Pushed by ashark into branch 'docbook_historied_per_file'.

Merge remote-tracking branch 'verahawk/xdg_spec'

Implements MR !122

Conflicts:
	kdesrc-build

Original commit: 989cf8e9
https://invent.kde.org/sdk/kdesrc-build/-/commit/989cf8e9f56c38ebbc01dae14cae6482285ae774

M  +9    -16   doc/kdesrc-buildrc/conf-options-table.docbook
M  +7    -57   doc/using-kdesrc-build/advanced-features.docbook

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

diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index 379cfa80..5c07eb25 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -214,16 +214,9 @@ change at all.</para></important>
 <row id="conf-checkout-only">
 <entry>checkout-only</entry>
 <entry>Module setting overrides global</entry>
-<entry><para>Set this option to checkout &subversion; sources piece by piece. The
-value for this option should be a space-separated list of directories to
-checkout.  Although this option overrides the global option, be aware that
-setting this as a global option makes no sense.
-</para>
-
-<para>Note that this setting has no effect on &git; modules due to the
-operation of the &git; source control system.</para>
-
-<para>See <xref linkend="checking-out-parts"/> for an example.</para></entry>
+<entry><para>This option was removed in January 2022. It used to control
+the ability to checkout subsets of a module from a Subversion repository.</para>
+</entry>
 </row>
 
 <row id="conf-cmake-generator">
@@ -412,13 +405,13 @@ for every module. You can disable this check by setting
 <entry><para>Use this option to select a specific set of directories not to be built in a
 module (instead of all of them). The directories not to build should be space-separated.</para>
 
-<para>Note that the sources to the programs will still be downloaded. You can use
-the <link linkend="conf-checkout-only">checkout-only</link>
-directive to choose directories that you want to check out.</para>
+<para>Note that the sources to the programs will still be downloaded.</para>
 
-<para>For example, to hold &juk; and &kscd; in the kdemultimedia module from
-compiling, you would add "do-not-compile juk kscd" to your kdemultimedia
-settings.</para>
+<para>For example, to disable building the <literal>codeeditor</literal> and <literal>minimaltest</literal>
+directories of the <literal>syntaxhighlighting</literal> framework, you
+would add <userinput>do-not-compile codeeditor minimaltest</userinput>
+compiling, you would add "do-not-compile juk kscd" to your syntaxhighlighting
+options.</para>
 
 <para>See <xref linkend="not-compiling"/> for an example.</para>
 </entry>
diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook
index 45e73a44..6c41cc2e 100644
--- a/doc/using-kdesrc-build/advanced-features.docbook
+++ b/doc/using-kdesrc-build/advanced-features.docbook
@@ -9,69 +9,19 @@ has features to make this easy. There are several complementing ways to
 do this.
 </para>
 
-<sect3 id="checking-out-parts">
-<title>Checking out portions of a module</title>
-
-<para>This is perhaps the best way to do this. When it works, it will save you
-download time and disk space. What happens is that &kdesrc-build; will download
-only the parts of a module that you specify. This is done using the &checkout-only;
-option for a module, which will specify a list of directories to download.
-</para>
-
-<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="https://websvn.kde.org/branches/KDE/4.6/">WebSVN</ulink>. <!--FIXME outdated-->
-</para></tip>
-
-<informalexample>
-<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 ksystemlog</replaceable>
-end module
-</screen>
-
-</informalexample>
-
-<important><para>The directories will be built in the order they are listed
-in the option. If one of the directories needs something else from the module
-to compile, then you need to make sure they are both in the &checkout-only;
-line, and that the required dependency goes before the directory that needs it.</para>
-
-<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. 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
-option, you should use <userinput><command>kdesrc-build</command>
-<option>&cmd-refresh-build;</option> <option><replaceable>module</replaceable></option></userinput>
-in order to ensure that the module is reconfigured properly. In addition,
-&kdesrc-build; will never remove existing files if you take away the number of
-directories from your &checkout-only; option, or add the option to a module that
-has already been checked out.</para>
-
-</sect3>
-
 <sect3 id="not-compiling">
 <title>Removing directories from a build</title>
-<para>Instead of restricting what is downloaded, it is possible to download
-everything but have the build system leave out a few directories when it does
-the build. This may be useful if one directory always breaks and is
-unnecessary to the rest of the module.
+<para>It is possible to download an entire repository
+but have the build system leave out a few directories when it does
+the build. This requires that the module uses &cmake; and that the
+module's build system allows the directory to remove to be
+optional.
 </para>
 
-<para>This is controlled with the &do-not-compile; option. It works similar
-to the &checkout-only; option just described, in that it is simply a list of
-directories that should not be compiled.</para>
+<para>This is controlled with the &do-not-compile; option.</para>
 
 <important><para>
-Also like &checkout-only;, this option requires at least that the
+This option requires at least that the
 build system for the module is reconfigured after changing
 it. This is done using the <userinput><command>kdesrc-build</command>
 <option>&cmd-reconfigure;</option>
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.