svn commit: r894749 - in /maven/plugins/trunk/maven-dependency-plugin/src: main/java/org/apache/maven/plugin/dependency/fromConfiguration/AbstractFromConfigurationMojo.java site/apt/usage.apt.vm

[da...@apache.org]

Author: dantran
Date: Thu Dec 31 01:00:59 2009
New Revision: 894749

URL: http://svn.apache.org/viewvc?rev=894749&view=rev
Log:
MDEP-226: document destFileName usage.

Modified:
    maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugin/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
    maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt.vm

Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugin/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugin/dependency/fromConfiguration/AbstractFromConfigurationMojo.java?rev=894749&r1=894748&r2=894749&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugin/dependency/fromConfiguration/AbstractFromConfigurationMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugin/dependency/fromConfiguration/AbstractFromConfigurationMojo.java Thu Dec 31 01:00:59 2009
@@ -92,8 +92,8 @@
 
     /**
      * Collection of ArtifactItems to work on. (ArtifactItem contains groupId,
-     * artifactId, version, type, classifier, location, destFile, markerFile and overwrite.)
-     * See "Usage" and "Javadoc" for details.
+     * artifactId, version, type, classifier, location, destFileName, markerFile and overwrite.)
+     * See <a href="./usage.html">Usage</a> for details.
      * 
      * @parameter
      * @required

Modified: maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt.vm?rev=894749&r1=894748&r2=894749&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/site/apt/usage.apt.vm Thu Dec 31 01:00:59 2009
@@ -135,6 +135,24 @@
 </project>
 +---+
 
+  <Notes:>
+  
+    * By default, artifacts are copied into <outputDirectory> using 
+      Maven artifact file name convention ( ie <artifactId-version-classifier.type> ).
+      Use the following rules to override the default convention:
+      
+      * Use <artifactItem.destFileName> to override the default file name.  
+        
+      * Use <stripVersion> to remove <version> from default file name.
+        This field is ignored when <artifactId.destFileName> is set.
+      
+      * Use <artifactItem.outputDirectory> to override the plugin's <outputDirectory> configuration 
+        per <artifactItem>.
+        
+      []
+      
+    []
+
 * The <<<dependency:copy-dependencies>>> mojo
 
    This goal can be bound to a lifecycle phase and configured in your <<<pom.xml>>>.
@@ -273,7 +291,6 @@
               <classifier> [classifier - optional] </classifier>
               <overWrite>[ true or false ]</overWrite>
               <outputDirectory>[ output directory ]</outputDirectory>
-              <destFileName>[ filename ]</destFileName>
               <includes>[ comma separated list of file filters ]</includes>
               <excludes>[ comma separated list of file filters ]</excludes>
             </artifactItem>