kaz 02/03/16 19:45:15
Modified: xdocs build-file.xml project-descriptor.xml
Log:
- Added a note about installing junit
- Updated the docs to reflect the two new elements of the project
descriptor that Jason added: <siteAddress> and <siteDirectory>.
Revision Changes Path
1.11 +17 -7 jakarta-turbine-maven/xdocs/build-file.xml
Index: build-file.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/build-file.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- build-file.xml 15 Mar 2002 01:39:32 -0000 1.10
+++ build-file.xml 17 Mar 2002 03:45:15 -0000 1.11
@@ -34,15 +34,18 @@
to use this build file. Without the project descriptor, Maven
cannot generate an object model for the project. In addition,
the Ant property <code>${lib.repo}</code> must be defined (see
- below).
+ below). Finally, you must also have JUnit installed to use
+ Maven because unit testing is based on the JUnit framework. To
+ install JUnit, place the <code>junit.jar</code> file in your
+ <code>$ANT_HOME/lib</code> directory.
</p>
<p>
The current recommended approach to using Maven is to add
delegators to these Maven-provided targets in your project's
main build file. This will enable you to use your existing
build file with the additional Maven functionality. For
- example, you could add the following to your <code>build.xml</code> file to
- Maven:
+ example, you could add the following to your
+ <code>build.xml</code> file to Maven:
</p>
<source><![CDATA[
<!-- maven:start -->
@@ -403,10 +406,7 @@
</tr>
<tr>
<td><a href="#maven:deploy-site">maven:deploy-site</a></td>
- <td>
- Generate the entire site including docs, javadocs,
- change log, and cross-referenced sources.
- </td>
+ <td>Deploys the entire site to the project's web server.</td>
</tr>
</table>
<p/>
@@ -464,6 +464,16 @@
necessary to build the entire web site documentation. This
includes all site docs, javadocs, cross-referenced sources,
change logs, metrics, and unit testing reports.
+ </p>
+ </subsection>
+ <subsection name="maven:deploy-site">
+ <p>
+ The <code>maven:deploy-site</code> target deploys the site to
+ the project's web server. SSH is used to transfer the
+ generated site to the web server and directory specified by
+ the <code>siteAddress</code> and <code>siteDirectory</code>
+ elements of the <a href="project-descriptor.html#project">
+ project descriptor</a>.
</p>
</subsection>
</section>
1.4 +20 -0 jakarta-turbine-maven/xdocs/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/project-descriptor.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- project-descriptor.xml 5 Mar 2002 01:38:16 -0000 1.3
+++ project-descriptor.xml 17 Mar 2002 03:45:15 -0000 1.4
@@ -63,6 +63,10 @@
<cvsWebUrl>
http://cvs.apache.org/viewcvs/jakarta-turbine-maven/
</cvsWebUrl>
+ <siteAddress>jakarta.apache.org</siteAddress>
+ <siteDirectory>
+ /www/jakarta.apache.org/turbine/maven/
+ </siteDirectory>
<repository id="jakarta"/>
@@ -369,6 +373,22 @@
<td>cvsWebUrl</td>
<td>
The URL to the project's browsable CVS repository
+ </td>
+ </tr>
+ <tr>
+ <td>siteAddress</td>
+ <td>
+ The hostname of the web server that hosts the project's web
+ site. This is used when the web site is <a
+ href="build-file.html#maven:deploy-site">deployed</a>.
+ </td>
+ </tr>
+ <tr>
+ <td>siteDirectory</td>
+ <td>
+ The directory on the web server where the public web site
+ for this project resides. This is used when the web site is <a
+ href="build-file.html#maven:deploy-site">deployed</a>.
</td>
</tr>
<tr>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
