maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject svn commit: r703884 - in /maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt: installation.apt reference.apt usage.apt
Date Sun, 12 Oct 2008 21:38:23 GMT
Author: hboutemy
Date: Sun Oct 12 14:38:22 2008
New Revision: 703884

URL: http://svn.apache.org/viewvc?rev=703884&view=rev
Log:
improved documentation

Modified:
    maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/installation.apt
    maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt
    maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/usage.apt

Modified: maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/installation.apt
URL: http://svn.apache.org/viewvc/maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/installation.apt?rev=703884&r1=703883&r2=703884&view=diff
==============================================================================
--- maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/installation.apt (original)
+++ maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/installation.apt Sun Oct 12
14:38:22 2008
@@ -33,7 +33,7 @@
 
   There are two ways to use the tasks from your scripts.
 
-* Installing in Ant's <<<lib>>> directory
+* Installing in Ant's {<<<lib>>>} directory
 
   This is the simplest installation method but requires changes on every machine using the
build file.
   You can place the JAR in your Ant <<<lib>>> directory, include it in
the <<<CLASSPATH>>> environment variable,
@@ -48,7 +48,7 @@
 </project>
 -----
 
-* Declaring a <<<typedef>>>
+* Declaring a {<<<typedef>>>}
 
   Using a <<<typedef>>> declaration allows you to store the Ant Tasks'
library anywhere you like (such as source control)
   and put it's location in the build file. This can be used to bootstrap the tasks by using
<<<get>>> to obtain

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=703884&r1=703883&r2=703884&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 Sun Oct 12 14:38:22
2008
@@ -60,7 +60,7 @@
 *-------------------------+---------------------------------------------------------------------------+--------------+-------------+
 | <<<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 |
+| <<<versionsId>>>        | The property ID to store the versions of the
resolved dependencies, for use by a {{{reference.html#VersionMapper} <<<VersionMapper>>>}}.
| No | 2.0.7 |
 *-------------------------+---------------------------------------------------------------------------+--------------+-------------+
 
   The task can include the <<<dependency>>> nested type, in addition to
the other shared types
@@ -71,16 +71,7 @@
        or a <<<pomRefId>>> attribute
        or one or more <<<dependency>>> elements.
 
-  If you have set a value for <<<versionsId>>>, you can later use <<<VersionMapper>>>,
for example during a copy:
-
------
-<copy todir="...">
-  <fileset refid="..." />
-  <mapper classpathref="maven-ant-tasks.classpath"
-          classname="org.apache.maven.artifact.ant.VersionMapper"
-          from="${...versionId property...}" to="flatten" />
-</copy>
------
+  If you have set a value for <<<versionsId>>>, you can later use {{{reference.html#VersionMapper}
<<<VersionMapper>>>}}.
 
   <(since 2.0.8)> For each dependency resolved, the property <<<groupId:artifactId:type[:classifier]>>>
is defined pointing to
   the corresponding file.
@@ -239,16 +230,21 @@
 | <<<id>>>         | The reference ID of this POM.                    
     | No           |
 *------------------+--------------------------------------------------------+--------------+
 
-* <<<{VersionMapper}>>>
+* <<<{VersionMapper}>>> <(since 2.0.7)>
 
   This is a {{{http://ant.apache.org/manual/CoreTypes/mapper.html}filename mapper}}
   that removes version info from the filename when copying dependencies. It can
   also, optionally, remove the directory info from the filename.
+  
+  The full class name to use in <<<classname>>> attribute of <<<\<mapper\>>>>
element is
+  <<<org.apache.maven.artifact.ant.VersionMapper>>>.
 
 *------------------+--------------------------------------------------------+--------------+
 | <<Attribute>>    | <<Description>>                            
           | <<Required>> |
 *------------------+--------------------------------------------------------+--------------+
-| <<<from>>>       | The original filename.                           
     | Yes          |
+| <<<from>>>       | The versions of the dependencies, as set by <<<versionsId>>>
attribute of <<<dependencies>>> task. | Yes |
 *------------------+--------------------------------------------------------+--------------+
 | <<<to>>>         | If this is set to <<<flatten>>>
the directory info is also removed from the filename. | No |
 *------------------+--------------------------------------------------------+--------------+
+
+  You can see a full working example in the {{{usage.html#versionsId} Usage}} page.
\ No newline at end of file

Modified: maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/usage.apt?rev=703884&r1=703883&r2=703884&view=diff
==============================================================================
--- maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/usage.apt (original)
+++ maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/usage.apt Sun Oct 12 14:38:22
2008
@@ -62,7 +62,7 @@
 
   <(since 2.0.8)> For each dependency resolved using either inline declaration or a
pom reference, the property 
   <<<groupId:artifactId:type[:classifier]>>> is defined pointing to the
corresponding file.  For example,
-  a resolved dependency on junit can be accessed in the following way.
+  a resolved dependency on junit can be accessed in the following way:
   
 -----
 <echo message="JUnit jar file downloaded to ${junit:junit:jar}"/>
@@ -99,7 +99,7 @@
 
     * <<<javadocFilesetId>>>, which will give you a fileset reference containing
javadoc artifacts, <(since 2.0.9)>
 
-    * <<<versionsId>>>, which can be used to drop version numbers in filenames
<(since 2.0.7)>
+    * {<<<versionsId>>>}, which can be used to drop version numbers in
filenames <(since 2.0.7)>
 
   For example, to populate <<<lib>>> with your dependencies without the
version in the filenames, <<<lib/src>>> with the corresponding sources
   and <<<lib/javadoc>>> with the corresponding javadocs:
@@ -134,7 +134,9 @@
 
   <<Note:>> In the above example you only need to specify
   <<<classpathref="maven-ant-tasks.classpath">>> if are using Maven Ant
Tasks
-  by declaring a <<<typedef>>>.
+  by {{{installation.html#typedef} declaring a <<<typedef>>>}}.
+  It can be omitted if Maven Ant Tasks was
+  {{{installation.html#lib} installed in Ant's <<<lib>>> directory}}.
 
 * Declaring Repositories
 



Mime
View raw message