[sdk/kdesrc-build/docbook_historied_per_file] doc: Rename qtdir option to qt-install-dir

Git commit a3230652ba0ab05f2b2213515fe5f65565e80694 by Andrew Shark.
Committed on 17/01/2024 at 16:57.
Pushed by ashark into branch 'docbook_historied_per_file'.

Rename qtdir option to qt-install-dir

Also remove usage of ancient environment variable QTDIR, which is not used today.

CC: #142

Original commit: 2a2f6fd7
https://invent.kde.org/sdk/kdesrc-build/-/commit/2a2f6fd7a956a3657908b91dfe074c544e954e74

M  +6    -7    doc/appendix-profile/old-profile-setup.docbook
M  +2    -2    doc/features/features-overview.docbook
M  +0    -1    doc/index.docbook
M  +7    -7    doc/kdesrc-buildrc/conf-options-table.docbook
M  +1    -1    doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
M  +1    -6    doc/using-kdesrc-build/basic-features.docbook

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

diff --git a/doc/appendix-profile/old-profile-setup.docbook b/doc/appendix-profile/old-profile-setup.docbook
index 987925fe..8942b9fe 100644
--- a/doc/appendix-profile/old-profile-setup.docbook
+++ b/doc/appendix-profile/old-profile-setup.docbook
@@ -25,25 +25,24 @@ and add to the end of the file:
 If you are building the qt module (you are by default), add instead:
 
 <programlisting>
-QTDIR=(path to qtdir)   # Such as ~/kdesrc/build/qt by default.
-PATH=${install-dir}/bin:$QTDIR/bin:$PATH
-MANPATH=$QTDIR/doc/man:$MANPATH
+PATH=${install-dir}/bin:${qt-install-dir}/bin:$PATH
+MANPATH=${qt-install-dir}/doc/man:$MANPATH
 
 # Act appropriately if LD_LIBRARY_PATH is not already set.
 if [ -z $LD_LIBRARY_PATH ]; then
-  LD_LIBRARY_PATH=${install-dir}:/lib:$QTDIR/lib
+  LD_LIBRARY_PATH=${install-dir}:/lib:${qt-install-dir}/lib
 else
-  LD_LIBRARY_PATH=${install-dir}:/lib:$QTDIR/lib:$LD_LIBRARY_PATH
+  LD_LIBRARY_PATH=${install-dir}:/lib:${qt-install-dir}/lib:$LD_LIBRARY_PATH
 fi
 
-export QTDIR PATH MANPATH LD_LIBRARY_PATH
+export PATH MANPATH LD_LIBRARY_PATH
 </programlisting>
 
 or, if you are not building qt (and are using your system &Qt; instead), add
 this instead:
 
 <programlisting>
-PATH=${install-dir}/bin:$QTDIR/bin:$PATH
+PATH=${install-dir}/bin:${qt-install-dir}/bin:$PATH
 
 # Act appropriately if LD_LIBRARY_PATH is not already set.
 if [ -z $LD_LIBRARY_PATH ]; then
diff --git a/doc/features/features-overview.docbook b/doc/features/features-overview.docbook
index 3f6c9de1..6637dc14 100644
--- a/doc/features/features-overview.docbook
+++ b/doc/features/features-overview.docbook
@@ -142,7 +142,7 @@ a base &kde; single-user installation from the anonymous source repositories.
 <listitem><para>
 Tilde-expansion for your configuration options. For example, you can
 specify:
-<programlisting>qtdir ~/kdesrc/build/qt</programlisting>
+<programlisting>install-dir ~/kde/usr</programlisting>
 </para></listitem>
 
 <listitem><para>
@@ -163,7 +163,7 @@ Forced full rebuilds, by running
 
 <listitem><para>
 You can specify various environment values to be used during the build,
-including <envar>QTDIR</envar>, <envar>DO_NOT_COMPILE</envar>,
+including <envar>DO_NOT_COMPILE</envar>
 and <envar>CXXFLAGS</envar>.
 </para></listitem>
 
diff --git a/doc/index.docbook b/doc/index.docbook
index a7dcc0d2..748187ca 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -39,7 +39,6 @@
 
   <!ENTITY configure-flags '<link linkend="conf-configure-flags">configure-flags</link>'>
   <!ENTITY install-dir '<link linkend="conf-install-dir">install-dir</link>'>
-  <!ENTITY qtdir '<link linkend="conf-qtdir">qtdir</link>'>
   <!ENTITY build-dir '<link linkend="conf-build-dir">build-dir</link>'>
   <!ENTITY source-dir '<link linkend="conf-source-dir">source-dir</link>'>
   <!ENTITY colorful-output '<link linkend="conf-colorful-output">colorful-output</link>'>
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index 7ee10c94..be58e68b 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -316,8 +316,8 @@ running times for &kdesrc-build;.</para>
 You cannot override this setting in a module option. The default value is
 the $<envar>PATH</envar> that is set when the script starts. This environment
 variable should include the colon-separated paths of your development
-toolchain. The paths <filename class="directory">install-dir/bin</filename> and
-<filename class="directory">$<envar>QTDIR</envar>/bin</filename> are automatically added. You
+toolchain. The paths <filename class="directory">${install-dir}/bin</filename> and
+<filename class="directory">${install-dir}/bin</filename> are automatically added. You
 may use the tilde (~) for any paths you add using this option.</para>
 </entry>
 </row>
@@ -811,7 +811,7 @@ in the path to have them expanded to the module's name.</para>
 <member>Default value</member><member>Auto detected</member>
 </simplelist>
 <para>Set this option to change the default name of the installed library directory
-inside ${install-dir} and $<envar>QTDIR</envar>. On many systems this is either
+inside ${install-dir} and ${qt-install-dir}. On many systems this is either
 "lib" or "lib64". Auto-detection is attempted to set the correct name by default,
 but if the guess is wrong then it can be changed with this setting.</para>
 </entry>
@@ -827,7 +827,7 @@ but if the guess is wrong then it can be changed with this setting.</para>
 <envar>LD_LIBRARY_PATH</envar> while building. You cannot override this setting
 in a module option. The default value is blank, but the paths <filename
 class="directory">${install-dir}/$<envar>LIBNAME</envar></filename> and <filename
-class="directory">$<envar>QTDIR</envar>/$<envar>LIBNAME</envar></filename> are automatically added.
+class="directory">${qt-install-dir}/$<envar>LIBNAME</envar></filename> are automatically added.
 You may use the tilde (~) for any paths you add using this option.</para>
 </entry>
 </row>
@@ -1033,13 +1033,13 @@ installs the module.
 </entry>
 </row>
 
-<row id="conf-qtdir">
-<entry><link linkend="conf-qtdir">qtdir</link></entry>
+<row id="conf-qt-install-dir">
+<entry><link linkend="conf-qt-install-dir">qt-install-dir</link></entry>
 <entry>
 <simplelist type='horiz' columns='2'>
 <member>Type</member><member>String</member>
 </simplelist>
-<para>Set this option to set the environment variable <envar>QTDIR</envar> while building.
+<para>This option controls where to install qt modules after build.
 If you do not specify this option, &kdesrc-build; will assume that &Qt; is
 provided by the operating system.
 </para>
diff --git a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
index adebe815..0ac0cf6f 100644
--- a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
+++ b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
@@ -236,7 +236,7 @@ option to find out more about it. To see the full list of options, see
 <listitem><para><link linkend="conf-configure-flags">configure-flags</link> to define what flags to configure &Qt; with.</para></listitem>
 <listitem><para><link linkend="conf-install-dir">install-dir</link>, to set the directory to install &kde; to.</para></listitem>
 <listitem><para><link linkend="conf-make-options">make-options</link>, to pass options to the &make; program (such as number of CPUs to use).</para></listitem>
-<listitem><para><link linkend="conf-qtdir">qtdir</link>, to set the path to &Qt;.</para></listitem>
+<listitem><para><link linkend="conf-qt-install-dir">qt-install-dir</link>, to set the directory to install &Qt; to.</para></listitem>
 <listitem><para><link linkend="conf-source-dir">source-dir</link>, to change where to download the source code to.</para></listitem>
 </itemizedlist>
 
diff --git a/doc/using-kdesrc-build/basic-features.docbook b/doc/using-kdesrc-build/basic-features.docbook
index 2331e2ab..f9ce58c1 100644
--- a/doc/using-kdesrc-build/basic-features.docbook
+++ b/doc/using-kdesrc-build/basic-features.docbook
@@ -12,7 +12,7 @@ located at <ulink
 url="http://code.qt.io/cgit/qt/">http://code.qt.io/cgit/qt/</ulink>.</para></note>
 
 <para>In order to build &Qt;, you should make sure that the
-<link linkend="conf-qtdir">qtdir</link> setting is set to the directory you'd
+<link linkend="conf-qt-install-dir">qt-install-dir</link> option is set to the directory you'd
 like to install &Qt; to, as described in <xref linkend="configure-data"/>.</para>
 
 <para>You should then ensure that the qt module is added to
@@ -75,11 +75,6 @@ automatically to <envar>PKG_CONFIG_PATH</envar>. This means that you do not
 need to use &set-env; to add these.
 </para></listitem>
 
-<listitem><para>
-The setting for &qtdir; is automatically propagated to the <envar>QTDIR</envar>
-environment variable while building.
-</para></listitem>
-
 </itemizedlist>
 
 </sect2>