[kdesrc-build/a-new-dependency-resolver-why-not] doc: Document the new --list-build and --dependency-tree commandline options.

[Johan Ouwerkerk]

Git commit 8bbd895462819835c9456ed846f623bb7341fa38 by Johan Ouwerkerk.
Committed on 31/03/2019 at 11:07.
Pushed by ouwerkerk into branch 'a-new-dependency-resolver-why-not'.

Document the new --list-build and --dependency-tree commandline options.

M  +29   -0    doc/index.docbook
M  +56   -0    doc/man-kdesrc-build.1.docbook

https://invent.kde.org/kde/kdesrc-build/commit/8bbd895462819835c9456ed846f623bb7341fa38

diff --git a/doc/index.docbook b/doc/index.docbook
index 4fbfe1b..881d861 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -3482,6 +3482,35 @@ also <xref linkend="kdesrc-buildrc" />.
 </para></listitem>
 </varlistentry>
 
+<varlistentry id="cmdline-list-build">
+<term><parameter>--list-build</parameter></term>
+<listitem>
+<para>
+    Lists the modules that would be built, in the order in which they would be built.
+    If applicable, the output listing also mentions which commit/branch/tag would be
+    selected for checkout.
+</para>
+<para>
+    This option is similar to
+    <link linkend="cmdline-print-modules"><option>--print-modules</option></link>.
+    For more detailed information on how modules relate to each other, see also:
+    <link linkend="cmdline-dependency-tree"><option>--dependency-tree</option></link>.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry id="cmdline-dependency-tree">
+<term><parameter>--dependency-tree</parameter></term>
+<listitem>
+<para>
+    Prints out dependency information on the modules that would be built using a tree
+    format (recursive). Listed information also includes which specific commit/branch/tag
+    is dependend on and whether or not the dependency would be built. Note: the generated
+    output may become quite large for applications with many dependencies.
+</para>
+</listitem>
+</varlistentry>
+
 <varlistentry id="cmdline-run">
 <term><parameter>--run</parameter></term>
 <listitem><para>
diff --git a/doc/man-kdesrc-build.1.docbook b/doc/man-kdesrc-build.1.docbook
index bf9f188..3743139 100644
--- a/doc/man-kdesrc-build.1.docbook
+++ b/doc/man-kdesrc-build.1.docbook
@@ -714,6 +714,62 @@ kdepim: master
 </listitem>
 </varlistentry>
 
+<varlistentry>
+<term>
+<option>--list-build</option>
+</term>
+
+<listitem>
+<para>
+    Takes all actions up to and including dependency reordering of the modules
+    specified on the command line (or configuration file), prints the modules
+    that would be processed one per line, and then exits without further action.
+</para>
+<para>
+    This option is similar to <option>--print-modules</option> but includes what specific
+    commit/branch/tag would be built as well. Furthermore, the order in which the modules
+    are listed corresponds to the order in which these would be built.
+</para>
+
+<para>
+    The <literal>kde-project</literal> metadata is downloaded first (though, see
+    <option>--pretend</option> or <option>--no-src</option>).
+</para>
+
+<para>
+    The output is not fully compatible with usage by scripts as other output messages
+    may be generated until the module list is shown.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>
+<option>--dependency-tree</option>
+</term>
+
+<listitem>
+<para>
+    Takes all actions up to and including dependency reordering of the modules
+    specified on the command line (or configuration file), and prints dependency
+    information for each selected module in a (recursive) tree output format. Generated
+    information includes which specific commit/branch/tag is depended on, as well as
+    whether the module would be built. Note that the output can become quite large for
+    applications with many dependencies or when many modules are (implicitly) selected.
+</para>
+
+<para>
+    The <literal>kde-project</literal> metadata is downloaded first (though, see
+    <option>--pretend</option> or <option>--no-src</option>).
+</para>
+
+<para>
+    The output is not fully compatible with usage by scripts as other output messages
+    may be generated until the module list is shown.
+</para>
+</listitem>
+</varlistentry>
+
 <varlistentry>
 <term>
 <option>--color</option>