[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Add short options for --[no-]include-dependencies.

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


Git commit 5c8758a40dd9c47b73c22f77be71f09a2051d3bf by Michael Pyne.
Committed on 07/09/2023 at 00:34.
Pushed by ashark into branch 'docbook_historied_per_file'.

Add short options for --[no-]include-dependencies.

This adds and documents -d as a short alias for --include-dependencies, and a corresponding -D as its negation.

While I'm at it, and at user request, this also adds short options for:

* --help
* --no-src
* --src-only
* --refresh-build
* --ignore-modules
* --resume-from and --resume-after

BUG:473859

Original commit: 5b155c5e
https://invent.kde.org/sdk/kdesrc-build/-/commit/5b155c5e29dd2d377fd1f84fb42d0e629a9f368b

M  +11   -11   doc/cmdline/supported-cmdline-params.docbook

https://invent.kde.org/sdk/kdesrc-build/-/commit/5c8758a40dd9c47b73c22f77be71f09a2051d3bf

diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook
index 75c2c452..6d5e4c00 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -18,7 +18,7 @@ configuration.
 </varlistentry>
 
 <varlistentry id="cmdline-help">
-<term><parameter>--help</parameter></term>
+<term><parameter>--help</parameter> (or <parameter>-h</parameter>)</term>
 <listitem><para>
 Only display simple help on this script.
 </para></listitem>
@@ -148,7 +148,7 @@ Be very descriptive about what is going on, and what &kdesrc-build; is doing.
 </varlistentry>
 
 <varlistentry id="cmdline-src-only">
-<term><parameter>--src-only</parameter> (or <parameter>--svn-only</parameter>)</term>
+<term><parameter>--src-only</parameter> (or <parameter>--svn-only</parameter> or <parameter>-s</parameter>)</term>
 <listitem><para>
 Only perform the source update. (The <parameter>--svn-only</parameter> is
 only supported for compatibility with older scripts).
@@ -197,8 +197,8 @@ work.</para></note>
 </varlistentry>
 
 <varlistentry id="cmdline-include-dependencies">
-<term><parameter>--include-dependencies</parameter></term>
-<term><parameter>--no-include-dependencies</parameter></term>
+<term><parameter>--include-dependencies</parameter> (or <parameter>-d</parameter>)</term>
+<term><parameter>--no-include-dependencies</parameter> (or <parameter>-D</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
@@ -217,7 +217,7 @@ automatic inclusion of additional dependency modules.</para>
 </varlistentry>
 
 <varlistentry id="cmdline-ignore-modules">
-<term><parameter>--ignore-modules</parameter></term>
+<term><parameter>--ignore-modules</parameter> (or <parameter>-!</parameter>)</term>
 <listitem><para>
 Do not include the modules passed on the rest of the command line in the
 update/build process (this is useful if you want to build most of the modules
@@ -227,7 +227,7 @@ a few).
 </varlistentry>
 
 <varlistentry id="cmdline-no-src">
-<term><parameter>--no-src</parameter> (or <parameter>--no-svn</parameter>)</term>
+<term><parameter>--no-src</parameter> (or <parameter>--no-svn</parameter> or <parameter>-S</parameter>)</term>
 <listitem><para>
 Skip contacting the &subversion; server. (The <parameter>--no-svn</parameter>
 parameter is only supported for compatibility with older versions of the
@@ -360,7 +360,7 @@ scratch.
 </varlistentry>
 
 <varlistentry id="cmdline-refresh-build">
-<term><parameter>--refresh-build</parameter></term>
+<term><parameter>--refresh-build</parameter> (or <parameter>-r</parameter>)</term>
 <listitem><para>
 Recreate the build system and make from scratch.
 </para></listitem>
@@ -379,7 +379,7 @@ linkend="cmdline-refresh-build">--refresh-build</link></parameter> is used.
 </varlistentry>
 
 <varlistentry id="cmdline-resume-from">
-<term><parameter>--resume-from</parameter></term>
+<term><parameter>--resume-from</parameter> (or <parameter>--from</parameter> or <parameter>-f</parameter>)</term>
 <listitem><para>
 This option is used to resume the build starting from the given module, which
 should be the next option on the command line. You should not
@@ -400,7 +400,7 @@ build.</para></listitem>
 </varlistentry>
 
 <varlistentry id="cmdline-resume-after">
-<term><parameter>--resume-after</parameter></term>
+<term><parameter>--resume-after</parameter> (or <parameter>--after</parameter> or <parameter>-a</parameter>)</term>
 <listitem><para>
 This option is used to resume the build starting after the given module, which
 should be the next option on the command line. You should not
@@ -449,7 +449,7 @@ This option was added with &kdesrc-build; 1.16.
 </varlistentry>
 
 <varlistentry id="cmdline-stop-before">
-<term><parameter>--stop-before</parameter></term>
+<term><parameter>--stop-before</parameter> (or <parameter>--until</parameter>)</term>
 <listitem><para>
 This command line option is used to stop the normal build process just
 <emphasis>before</emphasis> a module would ordinarily be built.
@@ -464,7 +464,7 @@ This command line option was added with &kdesrc-build; 1.16.
 </varlistentry>
 
 <varlistentry id="cmdline-stop-after">
-<term><parameter>--stop-after</parameter></term>
+<term><parameter>--stop-after</parameter> (or <parameter>--to</parameter>)</term>
 <listitem><para>
 This command line option is used to stop the normal build process just
 <emphasis>after</emphasis> a module would ordinarily be built.



More information about the kde-doc-english mailing list