kaz 02/03/17 20:59:01
Modified: xdocs build-file.xml
Log:
Updating the documentation.
- Added a note about the junit report that is generated.
- Previously, Maven "generated" the build files for users. This is not
entirely true anymore, the build system is "installed" now. Changed
the terminology used on the page to reflect this new paradigm.
Revision Changes Path
1.12 +15 -14 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.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- build-file.xml 17 Mar 2002 03:45:15 -0000 1.11
+++ build-file.xml 18 Mar 2002 04:59:01 -0000 1.12
@@ -14,11 +14,10 @@
manage projects that have been described with a valid Maven <a
href="project-descriptor.html">project descriptor</a>.
The build files that Maven <a href="getting-started.html">
- generates</a> are stored in <code>${maven.home}</code> (see
- below) directory to avoid clobbering project-specific build files.
+ installs</a> are stored in <code>${maven.home}</code> directory.
</p>
<p>
- The Ant build files, generated by Maven, contain several targets
+ The Ant build files, installed by Maven, contain several targets
that can be used to control the various aspects of the project
lifecycle such as compilation, execution of unit tests,
generation of site documentation, and much much more. These
@@ -34,10 +33,11 @@
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). 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.
+ below) as well as <code>${maven.home}</code>. 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
@@ -45,7 +45,7 @@
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:
+ <code>build.xml</code> file to utilize Maven:
</p>
<source><![CDATA[
<!-- maven:start -->
@@ -115,13 +115,13 @@
<p>
It is important to note the use of the <code>maven:start</code>
and <code>maven:end</code> delimeters. This will enable Maven
- to be upgraded in a seamless manner.
+ to be upgraded in a seamless manner in the future.
</p>
<p>
The following is a brief overview of the various build files
- that are generated by Maven in the <code>maven</code> directory.
- Targets in each of these files are discussed in subsequent
- sections.
+ that are installed by Maven in the <code>${maven.home}</code>
+ directory. Targets in each of these files are discussed in
+ subsequent sections.
</p>
<table>
<tr><th>Build File</th><th>Description</th></tr>
@@ -497,7 +497,7 @@
number of classes, types of classes, etc. This information
can be presented in various formats such as text and in a gui.
To use the gui, you must set the Ant property
- <code>use.jdepend.gui</code>. In addition, metrics are
+ <code>use.jdepend.gui</code>. In addition, the metrics are
generated as HTML when the <code>docs</code> target is
invoked.
</p>
@@ -533,7 +533,8 @@
The results of the tests are placed in the
<code>test-reports</code> directory relative to the base
directory of the project. If this directory does not exist,
- it is created.
+ it is created. In addition, an HTML report is generated when
+ the <code>docs</code> target is invoked.
</p>
</subsection>
</section>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
