kaz 02/05/05 12:50:15
Modified: xdocs/ref build-file.xml properties.xml
Log:
Trying to play catch up on all of the changes that haven't been
documented yet. This one in particular is about the new hook that
enables the source tree to be pre-processed or prepared prior to
compilation by Maven.
Revision Changes Path
1.3 +18 -2 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.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- build-file.xml 4 May 2002 16:34:18 -0000 1.2
+++ build-file.xml 5 May 2002 19:50:15 -0000 1.3
@@ -141,7 +141,13 @@
</tr>
<tr>
<td><a href="#maven:dist">maven:dist</a></td>
- <td>Generates source and binary distributions.</td>
+ <td>Generates source and binary distributions from a specified
+ CVS tag.</td>
+ </tr>
+ <tr>
+ <td><a href="#maven:dist">maven:dist-build</a></td>
+ <td>Generates source and binary distributions from the current
+ project directory.</td>
</tr>
<tr>
<td><a href="#maven:deploy-dist">maven:deploy-dist</a></td>
@@ -226,6 +232,16 @@
element of the Maven project descriptor.
</p>
<p>
+ If the source must be pre-processed or prepared before
+ compilation, Maven provides a hook into the build system
+ before the sources are compiled. Three properties must be set
+ to utilize the hook: <code>maven.delegatorBuildFile</code>,
+ <code>maven.prepareSourceTarget</code>, and
+ <code>maven.prepareSourceDirectory</code>. Please refer to
+ the <a href="properties.html#Compile Settings">Properties</a>
+ document for more information on these properties.
+ </p>
+ <p>
The classpath used during compilation is composed of all the
JARs listed as dependencies in the project descriptor. These
JARs are automatically downloaded by Maven if they don't exist
@@ -246,7 +262,7 @@
you have installed <code>aspectjrt.jar</code> and
<code>aspectjtools.jar</code> in the
<code>${ant.home}/lib</code> directory (although this default
- may be overridden via <a href="properties.html">Properties</a>).
+ may be overridden via <a href="properties.html#Compile
Settings">Properties</a>).
Finally, The aspect source files are determined from the <a
href="project-descriptor.html#aspectSourceDirectories"><code>aspectSourceDirectories</code></a>
element of the Maven project descriptor.
1.5 +82 -30 jakarta-turbine-maven/xdocs/ref/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/properties.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- properties.xml 4 May 2002 16:34:18 -0000 1.4
+++ properties.xml 5 May 2002 19:50:15 -0000 1.5
@@ -46,6 +46,13 @@
</td>
</tr>
<tr>
+ <td><a href="#Compile Settings">Compile</a></td>
+ <td>
+ These properties specify various settings that control
+ compilation of a project.
+ </td>
+ </tr>
+ <tr>
<td><a href="#Javadoc Settings">Javadoc</a></td>
<td>
These properties specify the Javadoc settings used when
@@ -154,36 +161,6 @@
target.
</td>
</tr>
- <tr>
- <td>maven.compile.aspects</td>
- <td>Yes</td>
- <td>
- Specifies that Aspects are included during compilation.
- Used by the <a href="build-file.html#maven:compile">maven:compile</a>
- target. The default value is <code>false</code>. Please
- refer to the <a href="http://www.aspectj.org/";>AspectJ</a>
- web site for more information on Aspect-Oriented
- Programming.
- </td>
- </tr>
- <tr>
- <td>maven.jar.aspectjrt</td>
- <td>Yes</td>
- <td>
- Specifies the default location of the <a
- href="http://www.aspectj.org/";>AspectJ</a> runtime JAR.
- The default value is <code>${ant.home}/lib</code>.
- </td>
- </tr>
- <tr>
- <td>maven.jar.aspectjtools</td>
- <td>Yes</td>
- <td>
- Specifies the default location of the <a
- href="http://www.aspectj.org/";>AspectJ</a> tools JAR.
- The default value is <code>${ant.home}/lib</code>.
- </td>
- </tr>
</table>
</section>
<section name="Directory Layout Settings">
@@ -273,6 +250,81 @@
stored. The generated xdocs are then later transformed to
HTML. The default value is
<code>${basedir}/generated-xdocs</code>.
+ </td>
+ </tr>
+ </table>
+ </section>
+ <section name="Compile Settings">
+ <table>
+ <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>maven.prepareSourceDirectory</td>
+ <td>Yes</td>
+ <td>
+ If this property is set, it specifies that the sources must
+ be prepared or pre-processed before being compiled. The
+ value of this property is the directory that Maven can find
+ the prepared sources when it begins compilation. It is the
+ responsibility of the user to populate this directory with
+ the prepared source tree.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.prepareSourceTarget</td>
+ <td>Yes</td>
+ <td>
+ This property is used to specify an Ant target in the
+ <code>maven.delegatorBuildFile</code> that will prepare the
+ sources for compilation and place the resulting source tree
+ in <code>maven.prepareSourceDirectory</code>. This target
+ is invoked by Maven prior to compilation. It is assumed
+ that the target called takes care of knowing when and when
+ not to regenerate, if you don't add any logic the source
+ preparation will happen repeatedly because of the
+ dependencies among the maven targets (which is currently a
+ result of ant deficiencies is passing around references).
+ </td>
+ </tr>
+ <tr>
+ <td>maven.delegatorBuildFile</td>
+ <td>Yes</td>
+ <td>
+ This property is used to specify the build file that
+ contains custom targets that Maven can callback to provide
+ additional hooks into the build system. For example, if
+ your source tree needs to be prepared prior to compilation,
+ Maven will call the Ant target specified by the
+ <code>maven.prepareSourceTarget</code> in this build file.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.compile.aspects</td>
+ <td>Yes</td>
+ <td>
+ Specifies that Aspects are included during compilation.
+ Used by the <a href="build-file.html#maven:compile">maven:compile</a>
+ target. The default value is <code>false</code>. Please
+ refer to the <a href="http://www.aspectj.org/";>AspectJ</a>
+ web site for more information on Aspect-Oriented
+ Programming.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.jar.aspectjrt</td>
+ <td>Yes</td>
+ <td>
+ Specifies the default location of the <a
+ href="http://www.aspectj.org/";>AspectJ</a> runtime JAR.
+ The default value is <code>${ant.home}/lib</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.jar.aspectjtools</td>
+ <td>Yes</td>
+ <td>
+ Specifies the default location of the <a
+ href="http://www.aspectj.org/";>AspectJ</a> tools JAR.
+ The default value is <code>${ant.home}/lib</code>.
</td>
</tr>
</table>
