kaz 02/04/23 08:53:54
Modified: xdocs build-file.xml integrate.xml project-descriptor.xml
properties.xml use.xml
Log:
Doc updates for the latest <organization> element changes, verify
project changes, and the start of reactor targets.
Revision Changes Path
1.28 +34 -9 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.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- build-file.xml 18 Apr 2002 13:03:38 -0000 1.27
+++ build-file.xml 23 Apr 2002 15:53:54 -0000 1.28
@@ -98,6 +98,13 @@
framework for in-container testing using tomcat.
</td>
</tr>
+ <tr>
+ <td><a href="#build-reactor.xml">build-reactor.xml</a></td>
+ <td>
+ Contains targets to generate and participate in a Maven
+ reactor.
+ </td>
+ </tr>
</table>
<p>
These build files utilize various properties for default and
@@ -121,10 +128,6 @@
<td> Displays the current environment settings.</td>
</tr>
<tr>
- <td><a href="#maven:update-jars">maven:update-jars</a></td>
- <td>Updates JARs required for building.</td>
- </tr>
- <tr>
<td><a href="#maven:compile">maven:compile</a></td>
<td>Compile project source code.</td>
</tr>
@@ -169,6 +172,10 @@
<td><a href="#maven:validate-pom">maven:validate-pom</a></td>
<td>Validates the project descriptor.</td>
</tr>
+ <tr>
+ <td><a href="#maven:verify-project">maven:verify-project</a></td>
+ <td>Updates the necessary dependencies for a project.</td>
+ </tr>
</table>
<p/>
<subsection name="maven:env">
@@ -180,15 +187,15 @@
debugging purposes.
</p>
</subsection>
- <subsection name="maven:update-jars">
+ <subsection name="maven:verify-project">
<p>
- The <code>maven:update-jars</code> target uses HTTP to download the jar
files
- required to build the project. The dependencies of
- a project are determined from the
+ The <code>maven:verify-project</code> target uses HTTP to
+ download the jar files required to build the project. The
+ dependencies of a project are determined from the
<a
href="project-descriptor.html#dependencies"><code>dependencies</code></a>
element of the Maven project descriptor. The JARs are
downloaded from the URL specified by the
- <code>maven.repo</code> property.
+ <code>${maven.remote.repo}</code> property.
</p>
<p>
The downloaded JARs are stored in the directory specified by
@@ -658,6 +665,24 @@
it is created. In addition, an HTML report is generated when
the <a href="#maven:docs"><code>maven:docs</code></a> target
is invoked.
+ </p>
+ </subsection>
+ </section>
+ <section name="build-reactor.xml">
+ <table>
+ <tr><th>Target</th><th>Description</th></tr>
+ <tr>
+ <td><a href="#maven:generate-reactor">maven:generate-reactor</a></td>
+ <td>Builds a reactor for Maven projects.</td>
+ </tr>
+ </table>
+ <p/>
+ <subsection name="maven:generate-reactor">
+ <p>
+ The <code>maven:generate-reactor</code> target generates a
+ build file that can be used to build multiple Maven-enabled
+ projects. [This is a new feature and will be documented in
+ more detail after the details have been flushed out.]
</p>
</subsection>
</section>
1.6 +12 -5 jakarta-turbine-maven/xdocs/integrate.xml
Index: integrate.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/integrate.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- integrate.xml 18 Apr 2002 13:03:38 -0000 1.5
+++ integrate.xml 23 Apr 2002 15:53:54 -0000 1.6
@@ -56,7 +56,10 @@
<name>jakarta-turbine-maven</name>
<id>maven</id>
<currentVersion>1.0-b3-dev</currentVersion>
- <organization>Apache Software Foundation</organization>
+ <organization>
+ <name>Apache Software Foundation</name>
+ <url>http://jakarta.apache.org/</url>
+ </organization>
<inceptionYear>2001</inceptionYear>
<package>org.apache.maven</package>
@@ -303,10 +306,6 @@
<ant antfile="${maven.home}/build-maven.xml" target="check-source"/>
</target>
-<target name="maven:update-jars">
- <ant antfile="${maven.home}/build-maven.xml" target="update-jars"/>
-</target>
-
<target name="maven:announce">
<ant antfile="${maven.home}/build-maven.xml" target="announce"/>
</target>
@@ -317,6 +316,14 @@
<target name="maven:validate-pom">
<ant antfile="${maven.home}/build-maven.xml" target="validate-pom"/>
+</target>
+
+<target name="maven:generate-reactor">
+ <ant antfile="${maven.home}/build-reactor.xml" target="generate-reactor"/>
+</target>
+
+<target name="maven:verify-project">
+ <ant antfile="${maven.home}/build-maven.xml" target="verify-project"/>
</target>
<!-- maven:end -->
1.23 +25 -4 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.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- project-descriptor.xml 23 Apr 2002 14:06:47 -0000 1.22
+++ project-descriptor.xml 23 Apr 2002 15:53:54 -0000 1.23
@@ -77,11 +77,10 @@
</td>
</tr>
<tr>
- <td>organization</td>
+ <td><a href="#organization">organization</a></td>
<td>
- The organization to which the project belongs. This value
- is used when generating <a href="build-file.html#javadocs">
- JavaDoc</a> copyright notices.
+ The organization to which the project belongs. This element
+ describes various attributes of the organization.
</td>
</tr>
<tr>
@@ -204,6 +203,28 @@
<td>
Describes the build environment of a project. This is used
when invoking the <a href="build-file.html">build system</a>.
+ </td>
+ </tr>
+ </table>
+ </section>
+ <section name="organization">
+ <p>
+ This element describes various attributes of the organziation to
+ which the project belongs. These attributes are utilized when
+ documentation is created (for copyright notices and links).
+ </p>
+ <table>
+ <tr><th>Element</th><th>Description</th></tr>
+ <tr>
+ <td>name</td>
+ <td>
+ The full name of the organization.
+ </td>
+ </tr>
+ <tr>
+ <td>url</td>
+ <td>
+ The URL to the organization's home page.
</td>
</tr>
</table>
1.10 +1 -1 jakarta-turbine-maven/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/properties.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- properties.xml 22 Apr 2002 15:01:54 -0000 1.9
+++ properties.xml 23 Apr 2002 15:53:54 -0000 1.10
@@ -91,7 +91,7 @@
</td>
</tr>
<tr>
- <td>maven.repo</td>
+ <td>maven.remote.repo</td>
<td>Yes</td>
<td>
Specifies a URL to a central JAR repository that is used
1.2 +24 -23 jakarta-turbine-maven/xdocs/use.xml
Index: use.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/use.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- use.xml 28 Mar 2002 18:57:11 -0000 1.1
+++ use.xml 23 Apr 2002 15:53:54 -0000 1.2
@@ -29,31 +29,23 @@
their CVS repositories. Maven eliminates this practice
altogether because it provides facilities to automatically
download and update all dependencies from a central repository.
- Thus, before you compile any Maven-enabled project, you should always
- download/update all of the required dependencies. Maven makes
- this easy, type the following:
+ Thus, before any Maven Ant target is executed, Maven will
+ automatically download/update all of the required dependencies
+ from the central repository defined by the
+ <code>${maven.repo.remote}</code> property (see the <a
+ href="properties.html#User Settings">Properties</a> document
+ for more information).
</p>
- <source><![CDATA[ant -f build-maven.xml maven:update-jars]]></source>
<p>
- As you can tell by the above command, the current Turbine
- projects have their Maven delegators in a separate build file to
- facilitate the migration to Maven (as described in a previous
- section). In the future, the Maven delegators will be part of
- the main build files of all the Turbine family of projects. The
- Maven project uses this approach itself (thus the above command
- would be <code>ant maven:update-jars</code>).
- </p>
- <p>
- After executing the above command, all of the project's
- dependencies have been downloaded to your
- <code>${lib.repo}</code> directory. Recall, Maven uses this to
- store all JAR files. There is one exception, non-distributable
- JARs will result in a message pointing you to the location where
- you can download the JAR yourself. You'll have to download those
- yourself (legal issues) and manually place them in
- <code>${lib.repo}</code>. After you have downloaded all of the
- dependent JARs, generating a JAR for a Maven-enabled Turbine project
- is easy. Type the following:
+ After Maven has automatically updated your dependencies, they are
+ stored in your <code>${lib.repo}</code> directory. Recall, Maven
+ uses this directory to store all JAR files. There is one
+ exception, non-distributable JARs will result in a message
+ pointing you to the location where you can download the JAR
+ yourself. You'll have to download those yourself (legal issues)
+ and manually place them in <code>${lib.repo}</code>. After you
+ have downloaded all of the dependent JARs, generating a JAR for a
+ Maven-enabled Turbine project is easy. Type the following:
</p>
<source><![CDATA[ant -f build-maven.xml maven:jar]]></source>
<p>
@@ -62,6 +54,15 @@
generate reports that are later parsed to create an HTML report
that is part of the generated site documentation. The JAR file
can also be automatically distributed.
+ </p>
+ <p>
+ As you can tell by the above command, the current Turbine
+ projects have their Maven delegators in a separate build file to
+ facilitate the migration to Maven (as described in a previous
+ section). In the future, the Maven delegators will be part of
+ the main build files of all the Turbine family of projects. The
+ Maven project uses this approach itself (thus the above command
+ would be <code>ant maven:update-jars</code>).
</p>
<p>
The biggest bang for you buck right now is the generation of your
