You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2008/07/17 23:03:09 UTC
svn commit: r677725 -
/maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt
Author: dennisl
Date: Thu Jul 17 14:03:08 2008
New Revision: 677725
URL: http://svn.apache.org/viewvc?rev=677725&view=rev
Log:
[MANTTASKS-114] Improve documentation
o Add table headers.
o Add table column for "Required".
o Add table column for "Since" where appropriate.
Modified:
maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt
Modified: maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt
URL: http://svn.apache.org/viewvc/maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt?rev=677725&r1=677724&r2=677725&view=diff
==============================================================================
--- maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt (original)
+++ maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt Thu Jul 17 14:03:08 2008
@@ -39,25 +39,27 @@
The dependencies task accepts the following attributes:
-*-------------------------+--------------------------------------------------------+
-| <<<filesetId>>> | The reference ID to store a fileset under, for the resolved dependencies.
-*-------------------------+--------------------------------------------------------+
-| <<<javadocFilesetId>>> | The reference ID to store a fileset under, for the javadoc attachements of the resolved dependencies. <(since 2.0.9)>
-*-------------------------+--------------------------------------------------------+
-| <<<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)>
-*-------------------------+--------------------------------------------------------+
-| <<<type>>> | The type of artifacts to be retrieved. The default is <<<jar>>>.
-*-------------------------+--------------------------------------------------------+
-| <<<useScope>>> | The scope to be retrieved.
-*-------------------------+--------------------------------------------------------+
-| <<<verbose>>> | If <<<true>>> this displays the results of each dependency resolution and their relationships. Default is <false>.
-*-------------------------+--------------------------------------------------------+
-| <<<versionsId>>> | The property ID to store the versions of the resolved dependencies, for use by a <<<VersionMapper>>>. <(since 2.0.7)>
-*-------------------------+--------------------------------------------------------+
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<Attribute>> | <<Description>> | <<Required>> | << Since >> |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<<filesetId>>> | The reference ID to store a fileset under, for the resolved dependencies. | No | |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<<javadocFilesetId>>> | The reference ID to store a fileset under, for the javadoc attachements of the resolved dependencies. | No | 2.0.9 |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<<pathId>>> | The reference ID to store a path under, for the resolved dependencies. | No | |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<<pomRefId>>> | The reference ID from a POM datatype defined earlier in the build file. | Yes, either this or a <<<pom>>> nested element or one or more <<<dependency>>> nested elements | |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<<sourcesFilesetId>>> | The reference ID to store a fileset under, for the sources attachements of the resolved dependencies. | No | 2.0.6 |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<<type>>> | The type of artifacts to be retrieved. The default is <<<jar>>>. | No | |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<<useScope>>> | The scope to be retrieved. | No | |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<<verbose>>> | If <<<true>>> this displays the results of each dependency resolution and their relationships. Default is <false>. | No | |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
+| <<<versionsId>>> | The property ID to store the versions of the resolved dependencies, for use by a <<<VersionMapper>>>. | No | 2.0.7 |
+*-------------------------+---------------------------------------------------------------------------+--------------+-------------+
The task can include the <<<dependency>>> nested type, in addition to the other shared types
<<<localRepository>>>, <<<pom>>> and <<<remoteRepository>>>, which will be explained later.
@@ -85,17 +87,19 @@
~~ TODO: Is system scope supported, in the table below?
-*------------------+--------------------------------------------------------+
-| <<<groupId>>> | The group ID of the dependency. <Required>
-*------------------+--------------------------------------------------------+
-| <<<artifactId>>> | The artifact ID of the dependency. <Required>
-*------------------+--------------------------------------------------------+
-| <<<version>>> | The version of the dependency. <Required>
-*------------------+--------------------------------------------------------+
-| <<<type>>> | The type of the dependency. The default is <<<jar>>>.
-*------------------+--------------------------------------------------------+
-| <<<scope>>> | The scope of the usage of the dependency, which affects which of that dependency's own dependencies are also retrieved. This can be <<<compile>>>, <<<runtime>>>, <<<test>>>, <<<provided>>>.
-*------------------+--------------------------------------------------------+
+*------------------+--------------------------------------------------------+--------------+
+| <<Attribute>> | <<Description>> | <<Required>> |
+*------------------+--------------------------------------------------------+--------------+
+| <<<groupId>>> | The group ID of the dependency. | Yes |
+*------------------+--------------------------------------------------------+--------------+
+| <<<artifactId>>> | The artifact ID of the dependency. | Yes |
+*------------------+--------------------------------------------------------+--------------+
+| <<<version>>> | The version of the dependency. | Yes |
+*------------------+--------------------------------------------------------+--------------+
+| <<<type>>> | The type of the dependency. The default is <<<jar>>>. | No |
+*------------------+--------------------------------------------------------+--------------+
+| <<<scope>>> | The scope of the usage of the dependency, which affects which of that dependency's own dependencies are also retrieved. This can be <<<compile>>>, <<<runtime>>>, <<<test>>>, <<<provided>>>. | No |
+*------------------+--------------------------------------------------------+--------------+
The dependency can also nest multiple <<<exclusion>>> elements.
@@ -103,11 +107,13 @@
An exclusion can be used to prevent the resolution of a particular artifact in the tree of the <<<dependency>>>.
-*------------------+--------------------------------------------------------+
-| <<<groupId>>> | The group ID of the dependency to exclude. <Required>
-*------------------+--------------------------------------------------------+
-| <<<artifactId>>> | The artifact ID of the dependency to exclude. <Required>
-*------------------+--------------------------------------------------------+
+*------------------+--------------------------------------------------------+--------------+
+| <<Attribute>> | <<Description>> | <<Required>> |
+*------------------+--------------------------------------------------------+--------------+
+| <<<groupId>>> | The group ID of the dependency to exclude. | Yes |
+*------------------+--------------------------------------------------------+--------------+
+| <<<artifactId>>> | The artifact ID of the dependency to exclude. | Yes |
+*------------------+--------------------------------------------------------+--------------+
* <<<install>>>, <<<deploy>>>
@@ -115,7 +121,7 @@
POM. Multiple artifacts can be attached during install/deploy using <<<attach>>> elements.
*---------------------+--------------------------------------------------------------------------+-------------------------------------------------+
-| Attribute | Description | Required |
+| <<Attribute>> | <<Description>> | <<Required>> |
*---------------------+--------------------------------------------------------------------------+-------------------------------------------------+
| <<<file>>> | The file to install in the repository. | Yes, except if packaging is <<<pom>>> |
*---------------------+--------------------------------------------------------------------------+-------------------------------------------------+
@@ -134,27 +140,29 @@
Multiple artifacts can be attached to the main artifact, for exemple: sources, javadocs, ...
-*------------------+--------------------------------------------------------+
-| <<<file>>> | The file to attach. <Required>
-*------------------+--------------------------------------------------------+
-| <<<type>>> | The type of the file. Defaults to <<<jar>>>.
-*------------------+--------------------------------------------------------+
-| <<<classifier>>> | The classifier of the file.
-*------------------+--------------------------------------------------------+
+*------------------+--------------------------------------------------------+--------------+
+| <<Attribute>> | <<Description>> | <<Required>> |
+*------------------+--------------------------------------------------------+--------------+
+| <<<file>>> | The file to attach. | Yes |
+*------------------+--------------------------------------------------------+--------------+
+| <<<type>>> | The type of the file. Defaults to <<<jar>>>. | No |
+*------------------+--------------------------------------------------------+--------------+
+| <<<classifier>>> | The classifier of the file. | No |
+*------------------+--------------------------------------------------------+--------------+
* <<<install-provider>>>
This task will install a Wagon provider, to add support for more protocols.
-*------------------+--------------------------------------------------------------------------+
-| Attribute | Description
-*------------------+--------------------------------------------------------------------------+
-| <<<artifactId>>> | The artifact ID of the provider to install. <Required>
-*------------------+--------------------------------------------------------------------------+
-| <<<groupId>>> | The group ID of the provider to install. The default is <<<org.apache.maven.wagon>>>. <(since 2.0.7)>
-*------------------+--------------------------------------------------------------------------+
-| <<<version>>> | The version of the provider to install. <Required>
-*------------------+--------------------------------------------------------------------------+
+*------------------+--------------------------------------------------------------------------+--------------+-------------+
+| <<Attribute>> | <<Description>> | <<Required>> | << Since >> |
+*------------------+--------------------------------------------------------------------------+--------------+-------------+
+| <<<artifactId>>> | The artifact ID of the provider to install. | Yes | |
+*------------------+--------------------------------------------------------------------------+--------------+-------------+
+| <<<groupId>>> | The group ID of the provider to install. The default is <<<org.apache.maven.wagon>>>. | No | 2.0.7 |
+*------------------+--------------------------------------------------------------------------+--------------+-------------+
+| <<<version>>> | The version of the provider to install. | Yes | |
+*------------------+--------------------------------------------------------------------------+--------------+-------------+
Type Reference
@@ -163,27 +171,31 @@
Specifies the location of the local repository of artifacts.
-*------------------+--------------------------------------------------------+
-| <<<layout>>> | The layout of the local repository. The valid options are <<<legacy>>> (Maven 1), or <<<default>>> (Maven 2). Defaults to <<<default>>>.
-*------------------+--------------------------------------------------------+
-| <<<path>>> | The directory of the local repository. <Required>
-*------------------+--------------------------------------------------------+
+*------------------+--------------------------------------------------------+--------------+-------------+
+| <<Attribute>> | <<Description>> | <<Required>> | << Since >> |
+*------------------+--------------------------------------------------------+--------------+-------------+
+| <<<layout>>> | The layout of the local repository. The valid options are <<<legacy>>> (Maven 1), or <<<default>>> (Maven 2). Defaults to <<<default>>>. | No | |
+*------------------+--------------------------------------------------------+--------------+-------------+
+| <<<path>>> | The directory of the local repository. | Yes | 2.0.7 |
+*------------------+--------------------------------------------------------+--------------+-------------+
- <<Note>>: until 2.0.6, attribute <<<path>>> was named <<<location>>>, but this has changed in 2.0.7 to solve a conflict with Ant 1.7.
+ <<Note>>: until 2.0.6, attribute <<<path>>> was named <<<location>>>, but this changed in 2.0.7 to solve a conflict with Ant 1.7.
* <<<remoteRepository>>>
Specifies the location of the remote repository.
-*----------------------+--------------------------------------------------------+
-| <<<layout>>> | The layout of the remote repository. The valid options are <<<legacy>>> (Maven 1), or <<<default>>> (Maven 2). Defaults to <<<default>>>.
-*----------------------+--------------------------------------------------------+
-| <<<releases>>> | Policies regarding downloading released artifacts.
-*----------------------+--------------------------------------------------------+
-| <<<snapshots>>> | Policies regarding downloading snapshot artifacts.
-*----------------------+--------------------------------------------------------+
-| <<<url>>> | The URL of the repository. <Required>
-*----------------------+--------------------------------------------------------+
+*----------------------+--------------------------------------------------------+--------------+
+| <<Attribute>> | <<Description>> | <<Required>> |
+*----------------------+--------------------------------------------------------+--------------+
+| <<<layout>>> | The layout of the remote repository. The valid options are <<<legacy>>> (Maven 1), or <<<default>>> (Maven 2). Defaults to <<<default>>>. | No |
+*----------------------+--------------------------------------------------------+--------------+
+| <<<releases>>> | Policies regarding downloading released artifacts. | No |
+*----------------------+--------------------------------------------------------+--------------+
+| <<<snapshots>>> | Policies regarding downloading snapshot artifacts. | No |
+*----------------------+--------------------------------------------------------+--------------+
+| <<<url>>> | The URL of the repository. | Yes |
+*----------------------+--------------------------------------------------------+--------------+
The <<<remoteRepository>>> can have the following nested elements: <<<authentication>>> and <<<proxy>>>.
@@ -191,13 +203,15 @@
Policies about downloading different types of artifacts.
-*----------------------+--------------------------------------------------------+
-| <<<checksumPolicy>>> | How to treat missing or incorrect checksums for the dependencies that are downloaded. Valid values are <<<warn>>> (<default>) and <<<fail>>>.
-*----------------------+--------------------------------------------------------+
-| <<<enabled>>> | Whether to download this type of artifact from the repository. Default is <<<true>>>.
-*----------------------+--------------------------------------------------------+
-| <<<updatePolicy>>> | How often to check for updates on dependencies that are snapshots or include a range of versions. Valid values are <<<never>>>, <<<interval:MINUTES>>>, <<<daily>>> (<default)>, <<<always>>>.
-*----------------------+--------------------------------------------------------+
+*----------------------+--------------------------------------------------------+--------------+
+| <<Attribute>> | <<Description>> | <<Required>> |
+*----------------------+--------------------------------------------------------+--------------+
+| <<<checksumPolicy>>> | How to treat missing or incorrect checksums for the dependencies that are downloaded. Valid values are <<<warn>>> (<default>) and <<<fail>>>. | No |
+*----------------------+--------------------------------------------------------+--------------+
+| <<<enabled>>> | Whether to download this type of artifact from the repository. Default is <<<true>>>. | No |
+*----------------------+--------------------------------------------------------+--------------+
+| <<<updatePolicy>>> | How often to check for updates on dependencies that are snapshots or include a range of versions. Valid values are <<<never>>>, <<<interval:MINUTES>>>, <<<daily>>> (<default)>, <<<always>>>. | No |
+*----------------------+--------------------------------------------------------+--------------+
** <<<authentication>>>
@@ -213,11 +227,13 @@
The POM element will load a POM file and make it available as a reference for the other tasks or as properties.
-*------------------+--------------------------------------------------------+
-| <<<file>>> | The file of the POM to load. <Required>
-*------------------+--------------------------------------------------------+
-| <<<id>>> | The reference ID of this POM.
-*------------------+--------------------------------------------------------+
+*------------------+--------------------------------------------------------+--------------+
+| <<Attribute>> | <<Description>> | <<Required>> |
+*------------------+--------------------------------------------------------+--------------+
+| <<<file>>> | The file of the POM to load. | Yes |
+*------------------+--------------------------------------------------------+--------------+
+| <<<id>>> | The reference ID of this POM. | No |
+*------------------+--------------------------------------------------------+--------------+
* <<<{VersionMapper}>>>
@@ -226,9 +242,9 @@
also, optionally, remove the directory info from the filename.
*------------------+--------------------------------------------------------+--------------+
-| <<Attribute>> | <<Description>> | <<Required>>
+| <<Attribute>> | <<Description>> | <<Required>> |
*------------------+--------------------------------------------------------+--------------+
-| <<<from>>> | The original filename. | Yes
+| <<<from>>> | The original filename. | Yes |
*------------------+--------------------------------------------------------+--------------+
-| <<<to>>> | If this is set to <<<flatten>>> the directory info is also removed from the filename. | No
+| <<<to>>> | If this is set to <<<flatten>>> the directory info is also removed from the filename. | No |
*------------------+--------------------------------------------------------+--------------+