leosimons 2003/04/06 01:26:03
Modified: site/xdocs project.xml workspace.xml
Log:
document junitreport functionality
Revision Changes Path
1.18 +104 -2 jakarta-gump/site/xdocs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/site/xdocs/project.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- project.xml 8 Feb 2003 00:14:37 -0000 1.17
+++ project.xml 6 Apr 2003 09:26:02 -0000 1.18
@@ -343,8 +343,8 @@
<tr>
<td>module</td>
<td>Make the entry for this project in the javadoc listing
- (see below) appear under the named instead of the enclosing
- module.</td>
+ (see below) appear under the named module instead of the
+ enclosing module.</td>
<td>No</td>
</tr>
</table>
@@ -406,6 +406,108 @@
<description dir="xerces">Xerces2 Implementation</description>
<description dir="other">Other Classes</description>
</javadoc>
+]]></source>
+
+ <p>must be used.</p>
+
+ </subsection>
+
+ <subsection name="junitreport">
+ <p>This declares where the outputs of the
+ <a
href="http://ant.apache.org/manual/OptionalTasks/junitreport.html";>junitreport</a>
+ tool outputs are placed. This option only has any meaning if the
+ <a href="workspace.html#junitreport"><junitreport></a> element
+ is present in the workspace definition.</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>nested</td>
+ <td>Name of a directory or file, relative to the srcdir of
+ the module containing this project. <b>Note that this
+ ignores any <a href="#home"><home></a>
+ settings.</b></td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>parent</td>
+ <td>Name of a directory or file, relative to the base directory
+ of the workspace.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>project</td>
+ <td>Label to use in the junitreport listing (see below).
+ Default is the name of the project.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>module</td>
+ <td>Make the entry for this project in the junitreport listing
+ (see below) appear under the named module instead of the
+ enclosing module.</td>
+ <td>No</td>
+ </tr>
+ </table>
+
+ <p><junitreport> supports a nested <description>
+ element, which can be used to set the title in the junitreport
+ listing. If no <description> element has been specified,
+ the title defaults to the description of the
+ project. <description> itself only supports nested
+ text and an optional dir attribute.</p>
+
+ <p>The <junitreport> elements of all projects are used to
+ create a single page, "junitreport.html" (like
+ <a href="http://lsd.student.utwente.nl/gump/junitreport.html";>this</a>)
+ listing the available sets of junit reports.</p>
+
+ <p>There are three different layouts a <junitreport> element
+ may create in the junitreport listing "junitreport.html":</p>
+
+ <ol>
+ <li>This is the only <junitreport> element associated with
+ the module, the result will look like<br/><br/>
+ <a href="#">label</a> - description<br/><br/></li>
+
+ <li>There are several <junitreport> elements associated with
+ the module, their labels are different from the name of the
+ module - the result will look like<br/><br/>
+ <b>name of the module</b> - description of the module
+ <blockquote>
+ <a href="#">label</a> - description<br/>
+ <a href="#">label2</a> - description2<br/>
+ </blockquote></li>
+
+ <li>There are several <junitreport> elements associated with
+ the module, their labels are all the same as the name of the
+ module - the result will look like<br/><br/>
+ <b>name of the module</b> - description of the module
+ <blockquote>
+ <a href="#">description</a><br/>
+ <a href="#">description2</a><br/>
+ </blockquote></li>
+
+ </ol>
+
+ <p><em>label</em> in this lists will be created from the project
+ attribute and <em>description</em> from the description child
+ element of <junitreport></p>
+
+ <p>If a given project wants to publish more than one junitreport
+ set, multiple <description> elements like in</p>
+
+ <source><![CDATA[
+ <junitreport nested="java/build/docs/reports" project="xml-xerces2">
+ <description dir="api">XML Standard API</description>
+ <description dir="xni">Xerces Native Interface</description>
+ <description dir="xerces">Xerces2 Implementation</description>
+ <description dir="other">Other Classes</description>
+ </junitreport>
]]></source>
<p>must be used.</p>
1.11 +36 -0 jakarta-gump/site/xdocs/workspace.xml
Index: workspace.xml
===================================================================
RCS file: /home/cvs/jakarta-gump/site/xdocs/workspace.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- workspace.xml 2 Apr 2002 12:58:04 -0000 1.10
+++ workspace.xml 6 Apr 2003 09:26:02 -0000 1.11
@@ -256,6 +256,42 @@
</table>
</subsection>
+ <subsection name="junitreport">
+ <p>Enables publishing of a summary page linking all of the junit
+ reports produced in the process. This will be placed in the
+ workspace log directory with the name "junitreport.html".</p>
+
+ <table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>url</td>
+ <td>The prefix to be used for hrefs on the junitreport.html
+ page. This can be used to point directly into the build
+ directory or used in conjunction with the <code>dir</code>
+ attribute described below. If this attribute is not
+ specified, <code>file:///</code> urls will be generated - this
+ is generally only suitable for viewing on the local
+ machine.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>dir</td>
+ <td>This attribute tells where the physical directory
+ associated with the url can be found. <b>Note:</b> the script
+ which copies the reports to this directory is named
+ pubreport.pl and is placed in the work subdirectory of gump.
+ You can generate this script using 'ant pubreport'.
+ Normally, it would be executed immediately after a
+ "build all"</td>
+ <td>No</td>
+ </tr>
+ </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
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
