[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Correct default directory-layout value in documentation.

Nate Graham null at kde.org
Fri May 10 10:16:51 BST 2024


Git commit 66b1f6258f0483c4e5b3fa1b51e4866a053c0268 by Nate Graham.
Committed on 02/11/2022 at 18:15.
Pushed by ashark into branch 'docbook_historied_per_file'.

Correct default directory-layout value in documentation.

It's "Flat" now, and has been for a while.

BUG: 461279

Original commit: 7fe7c940
https://invent.kde.org/sdk/kdesrc-build/-/commit/7fe7c940833018f578c006fb3159aa1f6f0ba42a

M  +4    -6    doc/kdesrc-buildrc/conf-options-table.docbook

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

diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index 5c07eb25..331fefee 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -599,10 +599,10 @@ instead, which offers more options.</para>
 <entry>Module setting overrides global</entry>
 <entry><para>This option is used to configure the layout which &kdesrc-build; should use when
 creating source and build directories.</para>
-<para>Currently, there are three possible values: <userinput>metadata</userinput>,
-<userinput>invent</userinput> and <userinput>flat</userinput></para>
-<para>The <userinput>flat</userinput> layout will group all modules directly underneath the top level
-source and build directories. For example,
+<para>Currently, there are three possible values: <userinput>flat</userinput>,
+<userinput>invent</userinput>, and <userinput>metadata</userinput>.</para>
+<para>The <userinput>flat</userinput> layout is the default value, and will group all modules
+directly underneath the top level source and build directories. For example,
 <literal>source/extragear/network/telepathy/ktp-text-ui</literal> in the <userinput>metadata</userinput>
 layout would be <literal>source/ktp-text-ui</literal> using the <userinput>flat</userinput> layout
 instead.
@@ -620,8 +620,6 @@ project metadata for these modules. This is a good choice if you want a director
 tracks with certain KDE processes, but note that this path is therefore not always stable. As a
 result, &kdesrc-build; may abandon an old copy of the repository and clone a new one for a project
 due to changes in the project metadata.</para>
-<para>By default the <userinput>metadata</userinput> layout will be used, to preserve backwards
-compatibility for existing users of &kdesrc-build;.</para>
 </entry>
 </row>
 



More information about the kde-doc-english mailing list