[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Audit and correct list of config file options.

[Michael Pyne]

Git commit 47384daef896d89d50c2e2764a7d59ef29005a67 by Michael Pyne.
Committed on 19/08/2012 at 22:21.
Pushed by ashark into branch 'docbook_historied_per_file'.

Audit and correct list of config file options.

This audit was just comparing the list of config file options between
the documentation's list of options and the list contained in
kdesrc-build.

This resulted in adding an option (persistent-data-file) to kdesrc-build
to indicate that it's expected, and documenting an option
(use-clean-install) that was present but undocumented.

Original commit: 5785d4e8
https://invent.kde.org/sdk/kdesrc-build/-/commit/5785d4e8295cae284d0c1a710e46b85747115f5c

M  +17   -0    doc/kdesrc-buildrc/conf-options-table.docbook

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

diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index e16dba09..119f113d 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -729,6 +729,23 @@ url="http://download.kde.org/download.php">its mirrors</ulink>.</para>
 </entry>
 </row>
 
+<row id="conf-use-clean-install">
+<entry>use-clean-install</entry>
+<entry>Module setting overrides global</entry>
+<entry><para>Set this option to <userinput>true</userinput> in order to
+have &kdesrc-build; run <command>make uninstall</command> directly before
+running <command>make install</command>.</para>
+
+<para>This can be useful in ensuring that there are not stray old library
+files, &cmake; metadata, etc. that can cause issues in long-lived &kde;
+installations. However this only works on build systems that support
+<command>make uninstall</command>.</para>
+
+<para>This option was added with &kdesrc-build; 1.12, but was not documented
+until &kdesrc-build; 1.16.</para>
+</entry>
+</row>
+
 <row>
 <entry>use-cmake</entry>
 <entry></entry>