[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Clean up --help, add stub for initial setup helper.

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


Git commit a9b4e5afadf744c73e09afee6745caa2c051ab2a by Michael Pyne.
Committed on 21/10/2018 at 01:57.
Pushed by ashark into branch 'docbook_historied_per_file'.

Clean up --help, add stub for initial setup helper.

Big thanks to the sysadmin team for setting up URL shortlinks for the
docs URLs!

This takes another step towards the idea of being able to automatically
install known dependencies for common distributions, adding .xsession,
adjusting .bashrc, making a configuration file, and all the other
initial tasks that need to be done.

Original commit: 6b48a781
https://invent.kde.org/sdk/kdesrc-build/-/commit/6b48a781caff3ba36bf74e5dbc8ba0e9258261a2

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

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

diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook
index 2ead61e1..1a5a74f6 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -41,6 +41,24 @@ prove useful in bug reports or when asking for help in forums or mailing lists.
 </listitem>
 </varlistentry>
 
+<varlistentry id="cmdline-initial-setup">
+<term><parameter>--initial-setup</parameter></term>
+<listitem><para>
+Has &kdesrc-build; perform the one-time initial setup necessary to prepare
+the system for &kdesrc-build; to operate, and for the newly-installed &kde;
+software to run.
+</para>
+<para>This includes:</para>
+<itemizedlist>
+<listitem><para>Installing known dependencies (on supported &Linux; distributions)</para></listitem>
+<listitem><para>Adding required environment variables to <literal>~/.bashrc</literal></para></listitem>
+<listitem><para>Setting up a <link linkend="setup-rcfile">configuration file</link></para></listitem>
+</itemizedlist>
+
+<para>Available since version 18.11.</para>
+</listitem>
+</varlistentry>
+
 <varlistentry id="cmdline-author">
 <term><parameter>--author</parameter></term>
 <listitem><para>



More information about the kde-doc-english mailing list