[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Remove update-shellrc step

Andrew Shark null at kde.org
Fri May 10 10:16:52 BST 2024


Git commit ba7e1d479cb21d3fa05efbd4a88adaae539f084d by Andrew Shark.
Committed on 15/02/2024 at 11:44.
Pushed by ashark into branch 'docbook_historied_per_file'.

Remove update-shellrc step

It basically just added to the shellrc the path to the running script. That is not handled correctly in all cases.

Also, it tried to add kdesrc-run bash autocompletion, but the code was not handling all cases correctly anyway.

Instead, we will offer to install the file in the correct place in the first place.
Regarding PATH, that should be in user's control.

Original commit: 5d7dcace
https://invent.kde.org/sdk/kdesrc-build/-/commit/5d7dcacee6fd89feae01f197e278f61a1ddead8b

M  +1    -12   doc/cmdline/supported-cmdline-params.docbook

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

diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook
index c3202192..a6d1a9aa 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -564,12 +564,11 @@ software to run.
 <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>This option is exactly equivalent to using
     <option><link linkend="cmdline-install-distro-packages">--install-distro-packages</link></option>
     <option><link linkend="cmdline-generate-config">--generate-config</link></option>
-    <option><link linkend="cmdline-update-shellrc">--update-shellrc</link></option> at the same time.
+    at the same time.
 </para>
 </listitem>
 </varlistentry>
@@ -593,16 +592,6 @@ Generate the &kdesrc-build; configuration file.
 </listitem>
 </varlistentry>
 
-<varlistentry id="cmdline-update-shellrc">
-<term><option><link linkend="cmdline-update-shellrc">--update-shellrc</link></option></term>
-<listitem><para>
-Edit the "~/.bashrc" (or other shell rc file) to add &kdesrc-build; to your <envar>$PATH</envar> variable and enable autocompletion.
-</para>
-<para>See also <option><link linkend="cmdline-initial-setup">--initial-setup</link></option></para>
-</listitem>
-</varlistentry>
-
-
 </variablelist>
 </sect2>
 



More information about the kde-doc-english mailing list