kaz 02/05/05 13:18:14
Modified: src/templates/build build.xml
xdocs/ref build-file.xml project-descriptor.xml
xdocs/start integrate.xml
Log:
More catch up on the docs. This change documents the changes Jason made
to the maven:dist target before he left for vacation. That target
expects a CVS tag to build the distribution from. If you want to build
the distribution from your current directory, you'll need to use
maven:dist-build target.
Revision Changes Path
1.33 +4 -0 jakarta-turbine-maven/src/templates/build/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/templates/build/build.xml,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -r1.32 -r1.33
--- build.xml 5 May 2002 12:05:13 -0000 1.32
+++ build.xml 5 May 2002 20:18:14 -0000 1.33
@@ -74,6 +74,10 @@
<ant antfile="$mavenDirectory/build-maven.xml" target="dist"/>
</target>
+ <target name="maven:dist-build">
+ <ant antfile="$mavenDirectory/build-maven.xml" target="dist-build"/>
+ </target>
+
<target name="maven:deploy-site">
<ant antfile="$mavenDirectory/build-docs.xml" target="deploy-site"/>
</target>
1.4 +45 -10 jakarta-turbine-maven/xdocs/ref/build-file.xml
Index: build-file.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/build-file.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- build-file.xml 5 May 2002 19:50:15 -0000 1.3
+++ build-file.xml 5 May 2002 20:18:14 -0000 1.4
@@ -145,7 +145,7 @@
CVS tag.</td>
</tr>
<tr>
- <td><a href="#maven:dist">maven:dist-build</a></td>
+ <td><a href="#maven:dist-build">maven:dist-build</a></td>
<td>Generates source and binary distributions from the current
project directory.</td>
</tr>
@@ -336,21 +336,56 @@
<subsection name="maven:dist">
<p>
The <code>maven:dist</code> target generates both a binary and
- source distributions of the project. The binary distribution
- includes the jar files as well as documentation. The source
- distribution includes all of the source as well as the
- <code>build.xml</code> and <code>default.properties</code>
- required for building the project. Both distributions are
- then packaged into <code>tar.gz</code> and <code>zip</code>
- format.
+ source distributions of the project from the specified CVS
+ tag. Typically, the CVS tag is specified via the
+ command-line: <code>ant -Dtag=CVS_TAG_NAME maven:dist</code>
+ where <code>CVS_TAG_NAME</code> is a CVS tag identifying the
+ distribution to build. The <code>cvsRoot</code> and
+ <code>cvsModule</code> elements of the project descriptor
+ provide the information required to check out the specific
+ sources (see the <a href="project-descriptor.html#project">Project
+ Descriptor</a> for more information on these elements).
+ </p>
+ <p>
+ The binary distribution includes the jar files as well
+ as documentation. The source distribution includes all of the
+ source as well as the <code>build.xml</code> and
+ <code>default.properties</code> required for building the
+ project. Both distributions are then packaged into
+ <code>tar.gz</code> and <code>zip</code> format.
</p>
<p>
The generated packages are placed in the <code>target</code>
directory relative to the base directory of the project. The
<a href="project-descriptor.html#project"><code>project</code></a>
element of the Maven project descriptor is used when creating
- the name of the distributions. The current naming convention is
- <code>projectid-version</code> for binary distributions and
+ the name of the distributions. The current naming convention
+ is <code>projectid-version</code> for binary distributions and
+ <code>projectid-version-src</code> for source distributions.
+ </p>
+ </subsection>
+ <subsection name="maven:dist-build">
+ <p>
+ The <code>maven:dist-build</code> target generates both a
+ binary and source distributions of the project from the
+ current project directory (unlike <code>maven:dist</code>
+ which builds a distribution from a specific CVS tag).
+ </p>
+ <p>
+ The binary distribution includes the jar files as well
+ as documentation. The source distribution includes all of the
+ source as well as the <code>build.xml</code> and
+ <code>default.properties</code> required for building the
+ project. Both distributions are then packaged into
+ <code>tar.gz</code> and <code>zip</code> format.
+ </p>
+ <p>
+ The generated packages are placed in the <code>target</code>
+ directory relative to the base directory of the project. The
+ <a href="project-descriptor.html#project"><code>project</code></a>
+ element of the Maven project descriptor is used when creating
+ the name of the distributions. The current naming convention
+ is <code>projectid-version</code> for binary distributions and
<code>projectid-version-src</code> for source distributions.
</p>
</subsection>
1.2 +18 -0 jakarta-turbine-maven/xdocs/ref/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/project-descriptor.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- project-descriptor.xml 1 May 2002 22:03:11 -0000 1.1
+++ project-descriptor.xml 5 May 2002 20:18:14 -0000 1.2
@@ -169,6 +169,24 @@
</td>
</tr>
<tr>
+ <td>cvsRoot</td>
+ <td>
+ Optional. The <code>CVSROOT</code> to use when checking out
+ sources for this project via CVS. This is used by Maven
+ when <a href="build-file.html#maven:dist">building
+ distributions</a> from specific CVS tags.
+ </td>
+ </tr>
+ <tr>
+ <td>cvsModule</td>
+ <td>
+ Optional. The CVS module to use when checking out
+ sources for this project via the <code>CVS</code> command.
+ This is used by Maven when <a href="build-file.html#maven:dist">building
+ distributions</a> from specific CVS tags.
+ </td>
+ </tr>
+ <tr>
<td><a href="#distributions">distributions</a></td>
<td>
Optional. Contain information on previous distributions of the
1.2 +14 -0 jakarta-turbine-maven/xdocs/start/integrate.xml
Index: integrate.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/start/integrate.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- integrate.xml 1 May 2002 22:03:12 -0000 1.1
+++ integrate.xml 5 May 2002 20:18:14 -0000 1.2
@@ -89,6 +89,9 @@
/www/jakarta.apache.org/builds/jakarta-turbine-maven/
</distributionDirectory>
+ <cvsRoot>:pserver:[EMAIL PROTECTED]:/home/cvspublic</cvsRoot>
+ <cvsModule>jakarta-turbine-maven</cvsModule>
+
<mailingLists>
<mailingList>
<name>Turbine User List</name>
@@ -276,6 +279,10 @@
<ant antfile="${maven.home}/build-maven.xml" target="dist"/>
</target>
+<target name="maven:dist-build">
+ <ant antfile="${maven.home}/build-maven.xml" target="dist-build"/>
+</target>
+
<target name="maven:deploy-site">
<ant antfile="${maven.home}/build-docs.xml" target="deploy-site"/>
</target>
@@ -421,6 +428,13 @@
links for your project. I.e. there is no need to
explicitly add this in your <code>xdocs/project.xml</code>
file.
+ </li>
+ <li>
+ If your project requires pre-processing of your source tree
+ before compilation, Maven provides a hook into the build
+ system to facilitate this process. Please see the <a
+ href="../ref/build-file.html#maven:compile">maven:compile</a>
+ documentation for more information.
</li>
<li>
The color scheme used by Maven when generating your
