Author: jvanzyl
Date: Sun Apr 22 08:29:49 2007
New Revision: 531203
URL: http://svn.apache.org/viewvc?view=rev&rev=531203
Log:
o applying Herve Boutemy's patch and just referencing Maven now as everything
is Maven 2
Modified:
maven/site/trunk/src/site/apt/ant-tasks.apt
Modified: maven/site/trunk/src/site/apt/ant-tasks.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/ant-tasks.apt?view=diff&rev=531203&r1=531202&r2=531203
==============================================================================
--- maven/site/trunk/src/site/apt/ant-tasks.apt (original)
+++ maven/site/trunk/src/site/apt/ant-tasks.apt Sun Apr 22 08:29:49 2007
@@ -1,21 +1,22 @@
--------
- Antlib for Maven 2.0
+ Ant Taks for Maven
--------
Brett Porter
+ Herve Boutemy
--------
24 June 2005
--------
-Antlib for Maven 2.0
+Antlib for Maven
- Maven 2.0 now comes with a set of Ant tasks that can be used to utilise
Maven's artifact handling features
+ Maven comes with a set of Ant tasks that can be used to utilise Maven's
artifact handling features
from within Ant. This includes:
* <Dependency management> - including transitive dependencies, scope
recognition and SNAPSHOT handling
* <Artifact deployment> - file and SSH based deployment to a Maven
repository
- * <POM processing> - for reading a Maven 2.0 <<<pom.xml>>> file
+ * <POM processing> - for reading a Maven 2.0.x <<<pom.xml>>> file
The Ant tasks can be downloaded from {{{download.html} Maven 2.0 download
page}}.
@@ -53,7 +54,7 @@
...
<typedef resource="org/apache/maven/artifact/ant/antlib.xml"
uri="urn:maven-artifact-ant">
<classpath>
- <pathelement location="lib/maven-artifact-ant-2.0.2-dep.jar" />
+ <pathelement location="lib/maven-ant-tasks-2.0.6.jar" />
</classpath>
</typedef>
...
@@ -191,18 +192,20 @@
...
-----
- The currently available providers are:
+ Maven Ant Tasks contain <<<file>>> and <<<http-lightweight>>> providers. The
other available providers are:
*--------------+--------------------------+-------------------+
| Protocol | Artifact ID | Version |
*--------------+--------------------------+-------------------+
-| <<<file>>> | <<<wagon-file>>> | <<<1.0-alpha-5>>> |
+| <<<http>>> | <<<wagon-http>>> | <<<1.0-beta-2>>> |
*--------------+--------------------------+-------------------+
-| <<<scp>>> | <<<wagon-ssh>>> | <<<1.0-alpha-5>>> |
+| <<<scp>>> | <<<wagon-ssh>>> | <<<1.0-beta-2>>> |
*--------------+--------------------------+-------------------+
-| <<<scpexe>>> | <<<wagon-ssh-external>>> | <<<1.0-alpha-5>>> |
+| <<<scpexe>>> | <<<wagon-ssh-external>>> | <<<1.0-beta-2>>> |
*--------------+--------------------------+-------------------+
-| <<<ftp>>> | <<<wagon-ftp>>> | <<<1.0-alpha-5>>> |
+| <<<ftp>>> | <<<wagon-ftp>>> | <<<1.0-beta-2>>> |
+*--------------+--------------------------+-------------------+
+| <<<webdav>>> | <<<wagon-webdav>>> | <<<1.0-beta-2>>> |
*--------------+--------------------------+-------------------+
* Using a Maven {POM} File
@@ -290,7 +293,16 @@
specified in the <<<settings.xml>>> file in Maven, and can be accessed from
the Ant tasks also.
The file is first looked for in <<<$\{user.home\}/.ant/settings.xml>>>, then
in <<<$\{user.home\}/.m2/settings.xml>>>
- so that the settings can be shared with Maven 2.0 itself.
+ so that the settings can be shared with Maven 2.0 itself. Note that it is
<<not>> looked for in
+ <<<$\{M2_HOME\}/conf/settings.xml>>> for the moment.
+
+ Since 2.0.6, you can read a settings file anywhere using <<<settingsFile>>>
attribute:
+
+-----
+<artifact:dependencies settingsFile="/opt/maven/conf/settings.xml">
+ ...
+</artifact:dependencies>
+-----
For example, to specify your proxy settings, you would specify the following
<<<settings.xml>>> file:
@@ -307,12 +319,28 @@
</settings>
-----
+ Or to specify a <<<central>>> mirror, you would specify the following
<<<settings.xml>>> file:
+
+-----
+<settings>
+ <mirrors>
+ <mirror>
+ <id>central.mirror</id>
+ <url>http://mirror.host.net/maven2</url>
+ <mirrorOf>central</mirrorOf>
+ </mirror>
+ </mirrors>
+</settings>
+-----
+
For more information in configuring <<<settings.xml>>>, see:
* {{{guides/mini/guide-configuring-maven.html} Configuring Maven}}.
* {{{maven-settings/settings.html} Settings Descriptor Reference}}.
+ * {{{guides/mini/guide-mirror-settings.html} Using Mirrors for
Repositories}}.
+
* There is a
{{{http://svn.apache.org/repos/asf/maven/components/trunk/maven-cli/src/conf/settings.xml}
sample settings file}}
in the Maven installation.
@@ -345,15 +373,21 @@
The dependencies task accepts the following attributes:
-*-----------------+--------------------------------------------------------+
-| <<<verbose>>> | If <<<true>>> this displays the results of each dependency
resolution and their relationships. Default is <false>.
-*-----------------+--------------------------------------------------------+
-| <<<filesetId>>> | The reference ID to store a fileset under for the resolved
dependencies.
-*-----------------+--------------------------------------------------------+
-| <<<pathId>>> | The reference ID to store a path under for the resolved
dependencies.
-*-----------------+--------------------------------------------------------+
-| <<<pomRefId>>> | The reference ID from a pom datatype defined earlier in
the build file.
-*-----------------+--------------------------------------------------------+
+*-------------------------+--------------------------------------------------------+
+| <<<verbose>>> | If <<<true>>> this displays the results of each
dependency resolution and their relationships. Default is <false>.
+*-------------------------+--------------------------------------------------------+
+| <<<filesetId>>> | The reference ID to store a fileset under for the
resolved dependencies.
+*-------------------------+--------------------------------------------------------+
+| <<<pathId>>> | The reference ID to store a path under for the
resolved dependencies.
+*-------------------------+--------------------------------------------------------+
+| <<<pomRefId>>> | The reference ID from a pom datatype defined
earlier in the build file.
+*-------------------------+--------------------------------------------------------+
+| <<<sourcesFilesetId>>> | The reference ID to store a fileset under for the
sources attachements of the resolved dependencies. <(since 2.0.6)>
+*-------------------------+--------------------------------------------------------+
+| <<<useScope>>> | The scope to be retrieved.
+*-------------------------+--------------------------------------------------------+
+| <<<type>>> | The type of artifacts to be retrieved. The default
is <<<jar>>>.
+*-------------------------+--------------------------------------------------------+
The task can include the <<<dependency>>> nested type, in addition to the
other shared types explained later.
You must include either:
@@ -387,10 +421,10 @@
| <<<artifactId>>> | The artifact ID of the dependency to exclude. <Required>
*------------------+--------------------------------------------------------+
-* <<<install>>>
+* <<<install>>>, <<<deploy>>>
- This task will install the given file into the local repository. It is
stored using the information in the supplied
- POM.
+ These tasks will install/deploy the given file into the local/remote
repository. It is stored using the information in the supplied
+ POM. Multiple artifacts can be attached during install/deploy using
<<<attach>>> elements.
*------------------+--------------------------------------------------------------------------+-------------------------------------------------+
| Attribute | Description
| Required |
@@ -401,24 +435,22 @@
*------------------+--------------------------------------------------------------------------+-------------------------------------------------+
The task must also take a either a nested <<<pom>>> element, or a pomRefId
attribute.
- The task can have an optional <<<localRepository>>> element.
+ The tasks can have an optional <<<localRepository>>> element.
-* <<<deploy>>>
+ <<<deploy>>> can have an optional <<<remoteRepository>>> element. If no
+ <<<remoteRepository>>> element is given, the <<<distributionManagement>>>
section of the POM is used.
- This task will deploy the given file into the remote repository. It is
stored using the information in the supplied
- POM.
+** <<<attach>>> <(since 2.0.6)>
-*------------------+----------------------------------------------------------------------------+-------------------------------------------------+
-| Attribute | Description
| Required |
-*------------------+----------------------------------------------------------------------------+-------------------------------------------------+
-| <<<file>>> | The file to deploy in the remote repository.
| Yes, except if packaging is pom |
-*------------------+----------------------------------------------------------------------------+-------------------------------------------------+
-| <<<pomRefId>>> | The reference ID from a pom datatype defined earlier in
the build file. | No, if a pom nested element is provided instead |
-*-----------------+--------------------------------------------------------+--------------------+-------------------------------------------------+
+ Multiple artifacts can be attached to the main artifact, for exemple:
sources, apidocs, ...
- The task must have either a nested <<<pom>>> or a pomRefId attribute.
- <<<deploy>>> can have an optional <<<remoteRepository>>> element. If no
- <<<remoteRepository>>> element is given, the <<<distributionManagement>>>
section of the POM is used.
+*------------------+--------------------------------------------------------+
+| <<<file>>> | The file to attach. <Required>
+*------------------+--------------------------------------------------------+
+| <<<type>>> | The type of the file. Defaults to <<<jar>>>.
+*------------------+--------------------------------------------------------+
+| <<<classifier>>> | The classifier of the file.
+*------------------+--------------------------------------------------------+
Type Reference
