[sdk/kdesrc-build/docbook_historied_per_file] doc: Use placeholders for real defaults in the kdesrc-buildrc.in

ivan tkachenko <[email protected]>
Newsgroups gmane.comp.kde.cvs,gmane.comp.kde.doc
Message-ID <[email protected]>
Git commit 412a0faee2858fc6d39cb4204cf750ff7664cd3a by ivan tkachenko, on behalf of Andrew Shark.
Committed on 26/11/2023 at 19:57.
Pushed by ashark into branch 'docbook_historied_per_file'.

Use placeholders for real defaults in the kdesrc-buildrc.in

To avoid divergence in real defaults and shadow defaults (installed in the values in generated config), see #132.  
Fix divergent compile-commands-linking.  
Use the correct values for real defaults (build-dir, kdedir, source-dir).

Original commit: 2f7b9477
https://invent.kde.org/sdk/kdesrc-build/-/commit/2f7b9477b7d44a2f88c148846c8f80f6921fd4ef

M  +2    -2    doc/appendix-profile/old-profile-setup.docbook
M  +2    -2    doc/getting-started/configure-data.docbook
M  +3    -3    doc/kdesrc-buildrc/conf-options-table.docbook
M  +2    -2    doc/using-kdesrc-build/advanced-features.docbook

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

diff --git a/doc/appendix-profile/old-profile-setup.docbook b/doc/appendix-profile/old-profile-setup.docbook
index b1210648..94d27624 100644
--- a/doc/appendix-profile/old-profile-setup.docbook
+++ b/doc/appendix-profile/old-profile-setup.docbook
@@ -26,7 +26,7 @@ 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 by default.
+KDEDIR=(path to kdedir) # Such as ~/kde/src by default.
 KDEDIRS=$KDEDIR
 PATH=$KDEDIR/bin:$QTDIR/bin:$PATH
 MANPATH=$QTDIR/doc/man:$MANPATH
@@ -45,7 +45,7 @@ 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 by default.
+KDEDIR=(path to kdedir)  # Such as ~/kde/src by default.
 KDEDIRS=$KDEDIR
 PATH=$KDEDIR/bin:$QTDIR/bin:$PATH
 
diff --git a/doc/getting-started/configure-data.docbook b/doc/getting-started/configure-data.docbook
index 4ce65d40..6b2e3371 100644
--- a/doc/getting-started/configure-data.docbook
+++ b/doc/getting-started/configure-data.docbook
@@ -30,7 +30,7 @@ The default settings should be appropriate to perform a
 <itemizedlist>
 <listitem><para><link linkend="conf-kdedir">kdedir</link>, which changes the
 destination directory that your &kde; software is installed to. This defaults to
-<filename class="directory">~/kde</filename>, which is a single-user
+<filename class="directory">~/kde/src</filename>, which is a single-user
 installation.</para></listitem>
 
 <listitem><para><link linkend="conf-branch-group">branch-group</link>, which can
@@ -48,7 +48,7 @@ that the branch group does not change unexpectedly.</para></tip>
 <listitem><para><link linkend="conf-source-dir">source-dir</link>, to control the directory
 &kdesrc-build; uses for downloading the source code, running the build process, and saving
 logs.
-This defaults to <filename class="directory">~/kdesrc</filename>.</para></listitem>
+This defaults to <filename class="directory">~/kde/src</filename>.</para></listitem>
 
 <listitem><para><link linkend="conf-cmake-options">cmake-options</link>, which
 sets the options to pass to the &cmake; command when building each module.
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index c9c6603e..b6488654 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -430,8 +430,7 @@ are three different ways to use it:
 <listitem><para>Relative to the &kde; &git; source directory (see <link
 linkend="conf-source-dir">the source-dir option</link>). This is the default,
 and is selected if you type a directory name that does not start with a tilde
-(~) or a slash (/).</para> <para>The default value is <filename
-class="directory">build</filename>.</para></listitem>
+(~) or a slash (/).</para></listitem>
 
 <listitem><para>Absolute path. If you specify a path that begins with a /, then
 that path is used directly. For example, <filename
@@ -446,6 +445,7 @@ class="directory">/home/user-name/builddir</filename>.</para></listitem>
 
 </orderedlist>
 
+<para>The default value is <filename class="directory">~/kde/build</filename>.</para>
 Perhaps surprisingly, this option can be changed per module.
 
 </entry>
@@ -766,7 +766,7 @@ flag.
 <entry>kdedir</entry>
 <entry>Module setting overrides global</entry>
 <entry>This option sets the directory that &kde; will be installed to after it
-is built. It defaults to <filename class="directory">~/kde</filename>. If you
+is built. It defaults to <filename class="directory">~/kde/src</filename>. 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.</entry>
diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook
index fd7dfdb9..edb19da7 100644
--- a/doc/using-kdesrc-build/advanced-features.docbook
+++ b/doc/using-kdesrc-build/advanced-features.docbook
@@ -259,9 +259,9 @@ next time the build process occurs, even if it would normally perform the
 faster incremental build.</para>
 
 <tip>
-<para>By default, the build directory is <filename class="directory">~/kdesrc/build/<replaceable>module</replaceable>/</filename>.
+<para>By default, the build directory is <filename class="directory">~/kde/build/<replaceable>module</replaceable>/</filename>.
 If you change the setting of the &build-dir; option, then use that instead of
-<filename class="directory">~/kdesrc/build</filename>.</para>
+<filename class="directory">~/kde/build</filename>.</para>
 </tip>
 
 <informalexample>
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.