kaz 02/04/29 12:27:24
Modified: xdocs build-file.xml properties.xml use.xml
Log:
Documentation clarifications, one of which was pointed out by Christian
Willy Asmussen <[EMAIL PROTECTED]>.
Revision Changes Path
1.31 +27 -24 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.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- build-file.xml 29 Apr 2002 14:22:52 -0000 1.30
+++ build-file.xml 29 Apr 2002 19:27:24 -0000 1.31
@@ -190,20 +190,21 @@
<subsection name="maven:verify-project">
<p>
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.remote.repo}</code> property.
- </p>
- <p>
- The downloaded JARs are stored in the directory specified by
- <code>${lib.repo}</code> property (note: this directory must
- exist). As an optimization, if <code>${lib.repo}</code> already
- contains the necessary jar file, Maven does not download it
- unless a newer jar file is available in which case it replaces
- the old version.
+ download the dependencies (JARs) required to build a
+ project. This target is automatically invoked whenever any
+ Maven target is invoked (users do not need to explicity invoke
+ this target). 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. Maven will
+ automatically download the dependencies only if they are not
+ present in the local repository (specified by the
+ <code>${lib.repo}</code> property). The dependencies are
+ downloaded from the remote repository (specifiec by the
+ <code>${maven.remote.repo}</code> property) and stored in the
+ local repository. If a dependency is not located in the local
+ or remote repositories, an error is reported and the build
+ stops, at which point, it is the responsibility of the user to
+ place the missing dependency in the local repository.
</p>
<p>
Users behind a firewall can optionally set the
@@ -215,19 +216,21 @@
</subsection>
<subsection name="maven:compile">
<p>
- The <code>maven:compile</code> target compiles all of the source
- files that are part of the project. The list of source files,
- more specifically the directories, is determined from the
- <a
href="project-descriptor.html#sourceDirectories"><code>sourceDirectories</code></a>
+ The <code>maven:compile</code> target compiles all of the
+ source files that are part of a project. The list of source
+ files, more specifically the directories, is determined from
+ the <a
href="project-descriptor.html#sourceDirectories"><code>sourceDirectories</code></a>
element of the Maven project descriptor.
</p>
<p>
- The classpath used when compiling is composed of all the jar
- files located in the <code>${lib.repo}</code> directory. Upon
- completion, the resulting class files are placed in the
- <code>target/classes</code> directory relative to the base
- directory of the project. If this directory does not exist,
- it is created.
+ 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
+ (see <a href="#maven:verify-project">maven:verify-project</a>
+ for details). After compilation, the resulting class files
+ are placed in the <code>target/classes</code> directory
+ relative to the base directory of the project. If this
+ directory does not exist, it is created.
</p>
<p>
Users interested in compiling with aspects enabled can set the
1.14 +16 -10 jakarta-turbine-maven/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/properties.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- properties.xml 29 Apr 2002 14:32:32 -0000 1.13
+++ properties.xml 29 Apr 2002 19:27:24 -0000 1.14
@@ -93,18 +93,22 @@
<td>lib.repo</td>
<td>No</td>
<td>
- 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.
+ Specifies the directory in the local file system that is
+ used as the local repository for JARs. The local repository
+ is used to store all of the dependencies for a project.
+ Used by the <a
href="build-file.html#maven:verify-project">maven:verify-project</a>
+ target.
</td>
</tr>
<tr>
- <td>maven.remote.repo</td>
+ <td>maven.repo.remote</td>
<td>Yes</td>
<td>
- Specifies a URL to a central JAR repository that is used
- when the <a href="#maven:update-jars">maven:update-jars</a>
- target is invoked. The default value of this property is <a
+ Specifies the URL to a central JAR repository that is used
+ when the <a
href="build-file.html#maven:verify-project">maven:verify-project</a>
+ target is invoked (this target is not normally invoked
+ directly by users as its invoked automatically by Maven upon
+ every invocation). The default value of this property is <a
href="http://jakarta.apache.org/turbine/jars/";>http://jakarta.apache.org/turbine/jars</a>.
</td>
</tr>
@@ -134,7 +138,8 @@
<td>Yes</td>
<td>
Specifies a proxy server to use when downloading JARs. Used
- by the <a href="#maven:update-jars">maven:update-jars</a> target.
+ by the <a href="#maven:verify-project">maven:verify-project</a>
+ target.
</td>
</tr>
<tr>
@@ -142,8 +147,9 @@
<td>Yes</td>
<td>
Specifies the port of the proxy server to use when
- downloading JARs. Used by the
- <a href="#maven:update-jars">maven:update-jars</a> target.
+ downloading JARs. Used by the <a
+ href="#maven:verify-project">maven:verify-project</a>
+ target.
</td>
</tr>
<tr>
1.4 +19 -17 jakarta-turbine-maven/xdocs/use.xml
Index: use.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/use.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- use.xml 27 Apr 2002 14:10:47 -0000 1.3
+++ use.xml 29 Apr 2002 19:27:24 -0000 1.4
@@ -28,24 +28,26 @@
of the JAR files required to build and distribute the projects in
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 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).
+ download all dependencies from a central repository. Thus,
+ before any Maven Ant target is executed, Maven will automatically
+ download all of the required dependencies from the remote
+ repository defined by the <code>${maven.repo.remote}</code>
+ property (see the <a
href="build-file.html#maven:verify-project">maven:verify-project</a>
+ documention for more information).
</p>
<p>
- 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:
+ After Maven has automatically downloaded your dependencies, they
+ are stored in your local repository (as specified by the
+ <code>${lib.repo}</code> property). Recall, Maven uses this
+ directory to store all JAR files. There are two exceptions: 1)
+ non-distributable JARs will result in a message pointing you to
+ the location where you can download the JAR yourself, and 2) JARs
+ that don't exist in the local or remote repositories will result
+ in an error. In either case, you'll have to download those
+ yourself 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,7 +64,7 @@
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>).
+ would be <code>ant maven:jar</code>).
</p>
<p>
The biggest bang for you buck right now is the generation of your
