[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesvn-buildrc: Fix a little bug with build-status I introduced last night.

[Michael Pyne]

Git commit 21e856cc51d05011599365fea808d3fe14874304 by Michael Pyne.
Committed on 24/07/2005 at 03:28.
Pushed by ashark into branch 'docbook_historied_per_file'.

Fix a little bug with build-status I introduced last night.

Implement wish 109443 (E-mail report on compile failure).

This adds two configuration file options:

email-address: kdesvn-build uses this address to send email from.  You don't
have to set it, but it's probably better if you do if you use any features
kdesvn-build will send email for (like the one I'm committing).

email-on-compile-error: This should be set to the email address to send email
to whenever a build error occurs.

The email isn't sent until kdesvn-build is done trying to build/install modules
so that kdesvn-build can collate the results first.  kdesvn-build will also
include excerpts from the error log so that you won't necessarily have to pull
up the log to see what happened.  If you didn't set an email address to send
from, kdesvn-build will use the send-to address as the send-from address.

svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=438049

Original commit: 6340cf7c
https://invent.kde.org/sdk/kdesrc-build/-/commit/6340cf7c007c4d415be4de8b61535c2469da6916

M  +32   -0    doc/kdesvn-buildrc/index.docbook

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

diff --git a/doc/kdesvn-buildrc/index.docbook b/doc/kdesvn-buildrc/index.docbook
index e159e073..694248bc 100644
--- a/doc/kdesvn-buildrc/index.docbook
+++ b/doc/kdesvn-buildrc/index.docbook
@@ -253,6 +253,38 @@ directive to choose directories that you want to check out.</para>
 </entry>
 </row>
 
+<row id="conf-email-address">
+<entry>email-address</entry>
+<entry>Can't be overridden</entry>
+<entry>
+<para>Set this option to the e-mail address kdesvn-build should send from should
+it ever need to send e-mail.  You do not need to worry about this if you don't
+use any feature which send e-mail.  (They are all disabled by default).
+</para>
+
+<para>Currently only <link linkend="conf-email-on-compile-error">email-on-compile-error</link>
+needs this option.
+</para>
+</entry>
+</row>
+
+<row id="conf-email-on-compile-error">
+<entry>email-on-compile-error</entry>
+<entry>Can't be overridden</entry>
+<entry>
+<para>You can set this option to the email address to send a report to when a
+module fails to build.  kdesvn-build will wait until all the modules are done
+and collate all of the results in the report.  The report is only sent if a
+module fails to build.
+</para>
+
+<para>Please see the <link linkend="conf-email-address">email-address</link>
+option to set the address kdesvn-build should send from, since the default
+is usually not what you want.
+</para>
+</entry>
+</row>
+
 <row id="conf-inst-apps">
 <entry>inst-apps</entry>
 <entry>Overrides global</entry>