bodewig 02/04/02 04:58:04
Modified: proposal/gump/site/xdocs project.xml workspace.xml
Log:
Add documentation for <nag>
Revision Changes Path
1.10 +66 -0 jakarta-alexandria/proposal/gump/site/xdocs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-alexandria/proposal/gump/site/xdocs/project.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- project.xml 24 Jan 2002 11:43:10 -0000 1.9
+++ project.xml 2 Apr 2002 12:58:04 -0000 1.10
@@ -294,6 +294,72 @@
</tr>
</table>
</subsection>
+
+ <subsection name="nag">
+ <p>If this element is present, an entry for this project will be
+ created in the file naglist. This enables email reports of
+ build failures.</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>subject</td>
+ <td>value for the Subject header of the mail report.
+ Defaults to "Build Failure - " and the name of the
+ project. Will be prefixed by the prefix defined in the <a
+ href="workspace.html#nag">workspace</a>.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>from</td>
+ <td>Sender address for the email report.</td>
+ <td>Yes, unless there is a "from" attribute in
+ each nested regexp element.</td>
+ </tr>
+ <tr>
+ <td>to</td>
+ <td>Recipient of the email report. Will be overridden by a
+ "to" attribute in the
+ <a href="workspace.html#nag">workspace</a>.</td>
+ <td>Yes, unless there is a "to" attribute in each
+ nested regexp element.</td>
+ </tr>
+ </table>
+
+ <p>A build failure is detected by matching the output of the
+ build against Perl regular expressions, the default is
+ <code>/BUILD FAILED/</code>. The regular expressions are
+ specified using nested regexp elements - you can associate
+ different email addresses and subjects with each expression.</p>
+
+ <p>The regexp element supports the same attributes as the nag
+ element with an additional (required) pattern attribute. This
+ attribute specifies the Perl regular expression to be used when
+ looking for a build failure.</p>
+
+ <p>The nag element itself can be used to set default values for
+ nested child elements:</p>
+
+ <source><![CDATA[
+<nag from="[EMAIL PROTECTED]" to="[EMAIL PROTECTED]" />
+]]></source>
+
+ <p>is a short-cut for</p>
+
+ <source><![CDATA[
+<nag>
+ <regexp pattern="/BUILD FAILED/"
+ from="[EMAIL PROTECTED]"
+ to="[EMAIL PROTECTED]"
+ subject="Build Failure - @name of project element@"/>
+</nag>
+]]></source>
+
+ </subsection>
</section>
</body>
</document>
1.10 +32 -0 jakarta-alexandria/proposal/gump/site/xdocs/workspace.xml
Index: workspace.xml
===================================================================
RCS file: /home/cvs/jakarta-alexandria/proposal/gump/site/xdocs/workspace.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- workspace.xml 14 Jan 2002 13:29:34 -0000 1.9
+++ workspace.xml 2 Apr 2002 12:58:04 -0000 1.10
@@ -256,6 +256,38 @@
</table>
</subsection>
+ <subsection name="nag">
+ <p>Gump will create a file called naglist in the work
+ subdirectory that can be used together with nag.pl to send email
+ reports of build failures to a list of recipients.
+ <b>Note:</b> reports will not be sent automatically, you have to
+ run nag.pl yourself.</p>
+
+ <p>A nag element in the workspace can be used to override some
+ values in project's <a href="project.html#nag">nag</a>
+ elements, which are used to define which reports will be
+ sent.</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>to</td>
+ <td>Overrides the to attributes of the nag elements in all
+ projects.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>prefix</td>
+ <td>A prefix to put into the subject of all generated nag
+ mails, defaults to "[GUMP]".</td>
+ <td>No</td>
+ </tr>
+ </table>
+ </subsection>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
