[sdk/kdesrc-build/docbook_historied_per_file] doc: Rename option "kdedir" to "install-dir"

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


Git commit 266f2e3bf47a1bc20da87d3d8e9cc0a871f5e2cb by Andrew Shark.
Committed on 03/01/2024 at 18:43.
Pushed by ashark into branch 'docbook_historied_per_file'.

Rename option "kdedir" to "install-dir"

The kdedir is ambiguous, it is not clear if it is source, build or install dir.

The kdedir naming dates back to the 2003 era when you had to define KDEDIR to define where KDE 3 was installed, just as QTDIR was used to define the location of the Qt 3 install.

mpyne later added prefix for non-KDE modules and should have switched things over afterwards but never got around to it.

By KDE SC 5 the requirement to use KDEDIR (or as it was by then, KDEDIRS) was dropped in favor of searching PATH.

See https://invent.kde.org/sdk/kdesrc-build/-/commit/2f7b9477b7d44a2f88c148846c8f80f6921fd4ef#note_839381

Original commit: e5c028cd
https://invent.kde.org/sdk/kdesrc-build/-/commit/e5c028cd18fa9f5e508e7b88d64033880eca7fa6

M  +10   -14   doc/appendix-profile/old-profile-setup.docbook
M  +1    -1    doc/cmdline/supported-cmdline-params.docbook
M  +1    -1    doc/features/features-overview.docbook
M  +1    -1    doc/getting-started/configure-data.docbook
M  +1    -1    doc/index.docbook
M  +6    -6    doc/kdesrc-buildrc/conf-options-table.docbook
M  +1    -1    doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
M  +0    -5    doc/using-kdesrc-build/basic-features.docbook

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

diff --git a/doc/appendix-profile/old-profile-setup.docbook b/doc/appendix-profile/old-profile-setup.docbook
index 1aa44da4..987925fe 100644
--- a/doc/appendix-profile/old-profile-setup.docbook
+++ b/doc/appendix-profile/old-profile-setup.docbook
@@ -26,37 +26,33 @@ 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.
-KDEDIR=(path to kdedir) # Such as ~/kde/usr by default.
-KDEDIRS=$KDEDIR
-PATH=$KDEDIR/bin:$QTDIR/bin:$PATH
+PATH=${install-dir}/bin:$QTDIR/bin:$PATH
 MANPATH=$QTDIR/doc/man:$MANPATH
 
 # Act appropriately if LD_LIBRARY_PATH is not already set.
 if [ -z $LD_LIBRARY_PATH ]; then
-  LD_LIBRARY_PATH=$KDEDIR/lib:$QTDIR/lib
+  LD_LIBRARY_PATH=${install-dir}:/lib:$QTDIR/lib
 else
-  LD_LIBRARY_PATH=$KDEDIR/lib:$QTDIR/lib:$LD_LIBRARY_PATH
+  LD_LIBRARY_PATH=${install-dir}:/lib:$QTDIR/lib:$LD_LIBRARY_PATH
 fi
 
-export QTDIR KDEDIRS PATH MANPATH LD_LIBRARY_PATH
+export QTDIR PATH MANPATH LD_LIBRARY_PATH
 </programlisting>
 
 or, if you are not building qt (and are using your system &Qt; instead), add
 this instead:
 
 <programlisting>
-KDEDIR=(path to kdedir)  # Such as ~/kde/usr by default.
-KDEDIRS=$KDEDIR
-PATH=$KDEDIR/bin:$QTDIR/bin:$PATH
+PATH=${install-dir}/bin:$QTDIR/bin:$PATH
 
 # Act appropriately if LD_LIBRARY_PATH is not already set.
 if [ -z $LD_LIBRARY_PATH ]; then
-  LD_LIBRARY_PATH=$KDEDIR/lib
+  LD_LIBRARY_PATH=${install-dir}/lib
 else
-  LD_LIBRARY_PATH=$KDEDIR/lib:$LD_LIBRARY_PATH
+  LD_LIBRARY_PATH=${install-dir}/lib:$LD_LIBRARY_PATH
 fi
 
-export KDEDIRS PATH LD_LIBRARY_PATH
+export PATH LD_LIBRARY_PATH
 </programlisting>
 </para>
 
@@ -80,7 +76,7 @@ variables in your <filename>.bash_profile</filename>:
 
 <programlisting>
 XDG_CONFIG_DIRS="/etc/xdg"
-XDG_DATA_DIRS="${KDEDIR}/share:/usr/share"
+XDG_DATA_DIRS="${install-dir}/share:/usr/share"
 export XDG_CONFIG_DIRS XDG_DATA_DIRS
 </programlisting>
 
@@ -102,7 +98,7 @@ Open the <filename>.xinitrc</filename> text file from the home directory, or
 create it if necessary. Add the line:
 
 <programlisting>
-<command>exec</command> <option>${KDEDIR}/bin/startkde</option>
+<command>exec</command> <option>${install-dir}/bin/startkde</option>
 </programlisting>
 </para>
 
diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook
index c44823ad..f5c288dd 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -608,7 +608,7 @@ environment as normal, and then execute the given program.</para>
 <para>This will not work to start a shell with the &kdesrc-build; environment
 in most cases however, since interactive shells typically reset at least part
 of the environment variables (such as <envar>PATH</envar> and
-<envar>KDEDIRS</envar>) in the startup sequence.
+${install-dir}) in the startup sequence.
 </para>
 
 <tip><para>If you want to see the environment used by &kdesrc-build;, you
diff --git a/doc/features/features-overview.docbook b/doc/features/features-overview.docbook
index 937f2941..3f6c9de1 100644
--- a/doc/features/features-overview.docbook
+++ b/doc/features/features-overview.docbook
@@ -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>KDEDIR</envar>, <envar>QTDIR</envar>, <envar>DO_NOT_COMPILE</envar>,
+including <envar>QTDIR</envar>, <envar>DO_NOT_COMPILE</envar>,
 and <envar>CXXFLAGS</envar>.
 </para></listitem>
 
diff --git a/doc/getting-started/configure-data.docbook b/doc/getting-started/configure-data.docbook
index 59021d25..a4019619 100644
--- a/doc/getting-started/configure-data.docbook
+++ b/doc/getting-started/configure-data.docbook
@@ -28,7 +28,7 @@ The default settings should be appropriate to perform a
 </para>
 
 <itemizedlist>
-<listitem><para><link linkend="conf-kdedir">kdedir</link>, which changes the
+<listitem><para><link linkend="conf-install-dir">install-dir</link>, which changes the
 destination directory that your &kde; software is installed to. This defaults to
 <filename class="directory">~/kde/usr</filename>, which is a single-user
 installation.</para></listitem>
diff --git a/doc/index.docbook b/doc/index.docbook
index d4acc526..64dc254d 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -38,7 +38,7 @@
   -->
 
   <!ENTITY configure-flags '<link linkend="conf-configure-flags">configure-flags</link>'>
-  <!ENTITY kdedir '<link linkend="conf-kdedir">kdedir</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>'>
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index 04faa8a4..c23c2c1b 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -316,7 +316,7 @@ 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">$<envar>KDEDIR</envar>/bin</filename> and
+toolchain. The paths <filename class="directory">install-dir/bin</filename> and
 <filename class="directory">$<envar>QTDIR</envar>/bin</filename> are automatically added. You
 may use the tilde (~) for any paths you add using this option.</para>
 </entry>
@@ -783,8 +783,8 @@ flag.</para>
 </entry>
 </row>
 
-<row id="conf-kdedir">
-<entry>kdedir</entry>
+<row id="conf-install-dir">
+<entry>install-dir</entry>
 <entry>
 <simplelist type='horiz' columns='2'>
 <member>Type</member><member>String</member>
@@ -806,7 +806,7 @@ well.</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 $<envar>KDEDIR</envar> and $<envar>QTDIR</envar>. On many systems this is either
+inside ${install-dir} and $<envar>QTDIR</envar>. 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>
@@ -821,7 +821,7 @@ but if the guess is wrong then it can be changed with this setting.</para>
 <para>Set this option to set the environment variable
 <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">$<envar>KDEDIR</envar>/$<envar>LIBNAME</envar></filename> and <filename
+class="directory">${install-dir}/$<envar>LIBNAME</envar></filename> and <filename
 class="directory">$<envar>QTDIR</envar>/$<envar>LIBNAME</envar></filename> are automatically added.
 You may use the tilde (~) for any paths you add using this option.</para>
 </entry>
@@ -1007,7 +1007,7 @@ the auto-detection. In this case you can manually specify the correct build type
 <member>Type</member><member>String</member>
 </simplelist>
 <para>This option controls where to install the module (normally the
-<option><link linkend="conf-kdedir">kdedir</link></option> setting is used).
+<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>
diff --git a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
index cb5ee3cd..d5c7e1e7 100644
--- a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
+++ b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
@@ -216,7 +216,7 @@ option to find out more about it. To see the full list of options, see
 <listitem><para><link linkend="conf-cmake-options">cmake-options</link> to define what flags to configure a module with using &cmake;.</para></listitem>
 <listitem><para><link linkend="conf-branch">branch</link>, to checkout from a branch instead of <literal>master</literal>.</para></listitem>
 <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-kdedir">kdedir</link>, to set the directory to install &kde; to.</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-source-dir">source-dir</link>, to change where to download the source code to.</para></listitem>
diff --git a/doc/using-kdesrc-build/basic-features.docbook b/doc/using-kdesrc-build/basic-features.docbook
index 9ef12211..2331e2ab 100644
--- a/doc/using-kdesrc-build/basic-features.docbook
+++ b/doc/using-kdesrc-build/basic-features.docbook
@@ -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 &kdedir; is automatically propagated to the <envar>KDEDIR</envar>
-environment variable while building. (<envar>KDEDIRS</envar> is not affected).
-</para></listitem>
-
 <listitem><para>
 The setting for &qtdir; is automatically propagated to the <envar>QTDIR</envar>
 environment variable while building.



More information about the kde-doc-english mailing list