[sdk/kdesrc-build/docbook_historied_per_file] doc: Eliminate distinction between `prefix` and `install-dir`

Andrew Shark <[email protected]>
Newsgroups gmane.comp.kde.cvs,gmane.comp.kde.doc
Message-ID <[email protected]>
Git commit 3d5459c7177e61a10e243789922e0dc885b45e98 by Andrew Shark.
Committed on 14/01/2024 at 01:38.
Pushed by ashark into branch 'docbook_historied_per_file'.

Eliminate distinction between `prefix` and `install-dir`

We will not use `--prefix` cli option or `prefix` config option anymore, because it means same thing what `install-dir` was meant for.

- For those who used '$MODULE' or '${MODULE}' in the `prefix` config option, we now will make that substitution in `install-dir` config option.
- Add a warning message if the prefix config option still found in user config

Closes #141

Original commit: 9b8ccbfe
https://invent.kde.org/sdk/kdesrc-build/-/commit/9b8ccbfe26bc751f42df49b2dc15f4a1ea886480

M  +3    -4    doc/cmdline/supported-cmdline-params.docbook
M  +7    -17   doc/kdesrc-buildrc/conf-options-table.docbook

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

diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook
index ab7923bc..71993bdc 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -526,11 +526,10 @@ linkend="cmdline-refresh-build">--refresh-build</link></parameter> is used.
 </para></listitem>
 </varlistentry>
 
-<varlistentry id="cmdline-prefix">
-<term><option>--prefix <replaceable>/path/to/kde</replaceable></option></term>
+<varlistentry id="cmdline-install-dir">
+<term><option>--install-dir <replaceable>path</replaceable></option></term>
 <listitem><para>
-This allows you to change the directory that &kde; will be installed to from
-the command line.  This option implies <link
+This allows you to change the directory where modules will be installed to. This option implies <link
 linkend="cmdline-reconfigure"><option>--reconfigure</option></link>,
 but using <link linkend="cmdline-refresh-build"><option>--refresh-build</option></link>
 may still be required.
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index e74858b1..86e35dbb 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -791,11 +791,17 @@ flag.</para>
 <member>Type</member><member>String</member>
 <member>Default value</member><member><filename class="directory">~/kde/usr</filename></member>
 </simplelist>
-<para>This option sets the directory that &kde; will be installed to after it
+<para>This option controls where to install the module after it
 is built. If you
 change this to a directory needing root access, you may want to read about the
 <link linkend="conf-make-install-prefix">make-install-prefix</link> option as
 well.</para>
+<para>
+Changing this option for specific module allows you to install it to a different directory than
+where the &kde; Platform libraries are installed, such as if you were using
+&kdesrc-build; only to build applications.</para>
+<para>You can use <varname>${MODULE}</varname> or <varname>$MODULE</varname>
+in the path to have them expanded to the module's name.</para>
 </entry>
 </row>
 
@@ -1001,22 +1007,6 @@ the auto-detection. In this case you can manually specify the correct build type
 </entry>
 </row>
 
-<row id="conf-prefix">
-<entry>prefix</entry>
-<entry>
-<simplelist type='horiz' columns='2'>
-<member>Type</member><member>String</member>
-</simplelist>
-<para>This option controls where to install the module (normally the
-<option><link linkend="conf-install-dir">install-dir</link></option> setting is used).
-Using this option allows you to install a module to a different directory than
-where the KDE Platform libraries are installed, such as if you were using
-&kdesrc-build; only to build applications.</para>
-<para>You can use <varname>${MODULE}</varname> or <varname>$MODULE</varname>
-in the path to have them expanded to the module's name.</para>
-</entry>
-</row>
-
 <row id="conf-purge-old-logs">
 <entry>purge-old-logs</entry>
 <entry>
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.