kaz 02/03/14 17:39:32
Modified: xdocs bootstrap.xml build-file.xml
Log:
Updated documentation to reflect the new ${maven.home} concept that has
been recently materialized.
Revision Changes Path
1.9 +16 -9 jakarta-turbine-maven/xdocs/bootstrap.xml
Index: bootstrap.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/bootstrap.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- bootstrap.xml 5 Mar 2002 17:04:29 -0000 1.8
+++ bootstrap.xml 15 Mar 2002 01:39:32 -0000 1.9
@@ -15,8 +15,9 @@
the necessary steps to successfully build Maven.
</p>
<p>
- For the impatient (assuming you have <code>${lib.repo}</code> in
- your Ant build properties):
+ For the impatient (assuming you have <code>${lib.repo}</code>
+ and optionally <code>${maven.home}</code> defined in your
+ ${user.home}/build properties):
</p>
<source><![CDATA[
ant -f build-bootstrap.xml update-jars
@@ -34,18 +35,24 @@
</p>
<p>
Next, you must define the <code>${lib.repo}</code> property in
- your <code>${user.home}/build.properties</code> file. If
- you do not have a <code>${user.home}/build.properties</code>
- file, create one in your home directory and add the
- following line:
+ your <code>${user.home}/build.properties</code> file. You
+ should also define <code>${maven.home}</code> here as well.
+ If you do not have a <code>${user.home}/build.properties</code>
+ file, create one in your home directory and add the following
+ lines:
</p>
<source><![CDATA[
lib.repo = /path/to/some/directory
+ maven.home = /path/to/some/other/directory
]]></source>
<p>
- The value of this property determines the location that the
- dependencies will be stored after they have been downloaded.
- Note: this directory must already exist in the filesystem.
+ The value of <code>${lib.repo}</code> property determines the
+ location that the dependencies will be stored after they have
+ been downloaded. Note: this directory must already exist in
+ the filesystem. The other value, <code>${maven.home}</code>
+ specifies the location that the build system will be stored
+ after it has been generated. It is optional and has a default
+ of <code>${user.home}/maven</code>.
</p>
<p>
You'll then need to download the dependencies for Maven before
1.10 +27 -19 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.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- build-file.xml 8 Mar 2002 01:14:24 -0000 1.9
+++ build-file.xml 15 Mar 2002 01:39:32 -0000 1.10
@@ -14,8 +14,8 @@
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 the <code>maven</code> directory to avoid
- clobbering project-specific build files.
+ generates</a> are stored in <code>${maven.home}</code> (see
+ below) directory to avoid clobbering project-specific build files.
</p>
<p>
The Ant build files, generated by Maven, contain several targets
@@ -33,9 +33,8 @@
reference. Recall, a valid Maven project descriptor is required
to use this build file. Without the project descriptor, Maven
cannot generate an object model for the project. In addition,
- the <code>maven.jar</code> file <b>must</b> be installed in
- <code>$ANT_HOME/lib</code> directory. Finally, the Ant property
- <code>${lib.repo}</code> must be defined (see below).
+ the Ant property <code>${lib.repo}</code> must be defined (see
+ below).
</p>
<p>
The current recommended approach to using Maven is to add
@@ -53,59 +52,59 @@
<!-- ======================================================== -->
<target name="maven:site">
- <ant antfile="maven/build-docs.xml" target="site"/>
+ <ant antfile="${maven.home}/build-docs.xml" target="site"/>
</target>
<target name="maven:jar">
- <ant antfile="maven/build-maven.xml" target="jar"/>
+ <ant antfile="${maven.home}/build-maven.xml" target="jar"/>
</target>
<target name="maven:install-jar">
- <ant antfile="maven/build-maven.xml" target="install-jar"/>
+ <ant antfile="${maven.home}/build-maven.xml" target="install-jar"/>
</target>
<target name="maven:env">
- <ant antfile="maven/build-maven.xml" target="env"/>
+ <ant antfile="${maven.home}/build-maven.xml" target="env"/>
</target>
<target name="maven:docs">
- <ant antfile="maven/build-docs.xml" target="docs"/>
+ <ant antfile="${maven.home}/build-docs.xml" target="docs"/>
</target>
<target name="maven:test">
- <ant antfile="maven/build-test.xml" target="test"/>
+ <ant antfile="${maven.home}/build-test.xml" target="test"/>
</target>
<target name="maven:clean">
- <ant antfile="maven/build-maven.xml" target="clean"/>
+ <ant antfile="${maven.home}/build-maven.xml" target="clean"/>
</target>
<target name="maven:metrics">
- <ant antfile="maven/build-metrics.xml" target="metrics"/>
+ <ant antfile="${maven.home}/build-metrics.xml" target="metrics"/>
</target>
<target name="maven:dist">
- <ant antfile="maven/build-maven.xml" target="dist"/>
+ <ant antfile="${maven.home}/build-maven.xml" target="dist"/>
</target>
<target name="maven:deploy-site">
- <ant antfile="maven/build-docs.xml" target="deploy-site"/>
+ <ant antfile="${maven.home}/build-docs.xml" target="deploy-site"/>
</target>
<target name="maven:gump-descriptor">
- <ant antfile="maven/build-maven.xml" target="gump-descriptor"/>
+ <ant antfile="${maven.home}/build-maven.xml" target="gump-descriptor"/>
</target>
<target name="maven:javadocs">
- <ant antfile="maven/build-docs.xml" target="javadocs"/>
+ <ant antfile="${maven.home}/build-docs.xml" target="javadocs"/>
</target>
<target name="maven:compile">
- <ant antfile="maven/build-maven.xml" target="compile"/>
+ <ant antfile="${maven.home}/build-maven.xml" target="compile"/>
</target>
<target name="maven:update-jars">
- <ant antfile="maven/build-maven.xml" target="update-jars"/>
+ <ant antfile="${maven.home}/build-maven.xml" target="update-jars"/>
</target>
<!-- maven:end -->
@@ -171,6 +170,15 @@
Specifies the directory on the file system that downloaded
jars are stored. Used by the
<a href="#maven:update-jars">maven:update-jars</a> target.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.home</td>
+ <td>Yes</td>
+ <td>
+ Specifies the directory on the file system that contains the
+ Maven build files that were generated. Used by all of the
+ targets.
</td>
</tr>
<tr>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
