[sdk/kdesrc-build/docbook_historied_per_file] doc: dep-resolv: Introduce --no-include-dependencies cmdline opt.

Michael Pyne null at kde.org
Fri May 10 10:16:37 BST 2024


Git commit 81561a4c01d925fc96d9489027f2eae915ae69e4 by Michael Pyne.
Committed on 31/08/2019 at 22:01.
Pushed by ashark into branch 'docbook_historied_per_file'.

dep-resolv: Introduce --no-include-dependencies cmdline opt.

Does what it says on the tin, to permit disabling dependency inclusion
on a one-time basis without editing config file. This just involved
moving changing this option internally to be a 'global flag' which
already are automagically able to be negated by precedining with --no-.

When adding documentation for it I noticed I had not documented it in
the Docbook docs so I've added docs for that and --include-dependencies
also and updated copyright.

This should also support updating other documentation for the issue
being tracked at #31

Original commit: 6c10817e
https://invent.kde.org/sdk/kdesrc-build/-/commit/6c10817e55adcbb14ff17b5df8c224f5e416862c

M  +20   -0    doc/cmdline/supported-cmdline-params.docbook
M  +2    -1    doc/index.docbook
M  +3    -3    doc/kdesrc-buildrc/conf-options-table.docbook

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

diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook
index 0123ec89..25c4f8cc 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -196,6 +196,26 @@ work.</para></note>
 </listitem>
 </varlistentry>
 
+<varlistentry id="cmdline-include-dependencies">
+<term><parameter>--include-dependencies</parameter></term>
+<term><parameter>--no-include-dependencies</parameter></term>
+<listitem><para>
+This option causes &kdesrc-build; to automatically include other &kde; and &Qt;
+modules in the build, if required for the modules you have requested to build
+on the command line or in your
+<link linkend="configure-data">configuration file</link>.</para>
+
+<para>The modules that are added are as recorded within the &kde; source code
+management system. See <xref linkend="kde-projects-module-sets"/>.</para>
+
+<para>The corresponding configure file option is
+<link linkend="conf-include-dependencies">include-dependencies</link>.</para>
+
+<para>You can also use <parameter>--no-include-dependencies</parameter>, which turns off
+automatic inclusion of additional dependency modules.</para>
+</listitem>
+</varlistentry>
+
 <varlistentry id="cmdline-ignore-modules">
 <term><parameter>--ignore-modules</parameter></term>
 <listitem><para>
diff --git a/doc/index.docbook b/doc/index.docbook
index 95c98c33..d9115de7 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -2,7 +2,7 @@
 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
   <!--
     Documentation for kdesrc-build.
-    Copyright (c) 2005-2008, 2010-2018 Michael Pyne <mpyne at kde.org>
+    Copyright (c) 2005-2008, 2010-2019 Michael Pyne <mpyne at kde.org>
 
     Copyright (c) 2005 Carlos Leonhard Woelz <carloswoelz at imap-mail.com>
     Copyright (c) 2009 Burkhard Lück <lueck at hube-lueck.de>
@@ -133,6 +133,7 @@
 <year>2016</year>
 <year>2017</year>
 <year>2018</year>
+<year>2019</year>
 <holder>Michael Pyne</holder>
 </copyright>
 
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index e03acc8d..1d0e8ca7 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -576,9 +576,9 @@ modules</link>, and requires that the metadata maintained by the &kde;
 developers is accurate for your selected <link
 linkend="conf-branch-group">branch-group</link>.</para></note>
 
-<para>This option is disabled by default, to avoid inadvertently selecting a
-bunch of modules that were not desired. It was added with &kdesrc-build;
-1.16 in 2015.</para>
+<para>This option is enabled by default, to support building applications
+that need versions of &Qt; or &plasma; more recent than supported on
+common operating systems.</para>
 </entry>
 </row>
 



More information about the kde-doc-english mailing list