[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Add a --print-modules command line option.

Michael Pyne <[email protected]>
Newsgroups gmane.comp.kde.cvs,gmane.comp.kde.doc
Message-ID <[email protected]>
Git commit a1a3089ddaa94f48a3910f2a94d3c89d34192054 by Michael Pyne.
Committed on 06/02/2014 at 05:20.
Pushed by ashark into branch 'docbook_historied_per_file'.

Add a --print-modules command line option.

Does about what it sounds like, but quicker. Useful for checking to see
what kdesrc-build is resolving module dependencies to. The beginning
output is intermixed but you can grep for "* Module list" if you want
and everything after will be module names.

Original commit: 6c49f524
https://invent.kde.org/sdk/kdesrc-build/-/commit/6c49f52422fcc4c09960b8aaa36375d652c6c531

M  +30   -0    doc/cmdline/supported-cmdline-params.docbook

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

diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook
index c5b53460..e4981cc0 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -296,6 +296,36 @@ also <xref linkend="kdesrc-buildrc" />.
 </para></listitem>
 </varlistentry>
 
+<varlistentry id="cmdline-print-modules">
+<term><parameter>--print-modules</parameter></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>
+    The <literal>kde-project</literal> metadata is downloaded first (though, see
+    <link linkend="cmdline-pretend"><option>--pretend</option></link> or <link
+    linkend="cmdline-no-src"><option>--no-src</option></link>).
+</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>
+<para>
+    This is mostly just useful for quickly determining what &kdesrc-build;
+    understands a module's dependencies to be, which means it's only useful for
+    <link
+    linkend="kde-projects-module-sets"><literal>kde-projects</literal></link>
+    modules.  This option is also compatible with <link
+    linkend="cmdline-resume-from"><option>--resume-from</option></link>, <link
+    linkend="cmdline-resume-after"><option>--resume-after</option></link>,
+    <link linkend="cmdline-stop-before"><option>--stop-before</option></link>,
+    <link linkend="cmdline-stop-after"><option>--stop-after</option></link>.
+</para></listitem>
+</varlistentry>
+
 <varlistentry id="cmdline-run">
 <term><parameter>--run</parameter></term>
 <listitem><para>
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.