svn commit: r1068108 - in /maven/plugins/trunk/maven-assembly-plugin/src/main: java/org/apache/maven/plugin/assembly/mojos/AbstractAssemblyMojo.java mdo/descriptor.mdo

[de...@apache.org]

Author: dennisl
Date: Mon Feb  7 20:34:57 2011
New Revision: 1068108

URL: http://svn.apache.org/viewvc?rev=1068108&view=rev
Log:
[MASSEMBLY-534] Doc unclear on descriptor refs
Submitted by: Benson Margulies
Reviewed by: Dennis Lundberg

Modified:
    maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/mojos/AbstractAssemblyMojo.java
    maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo

Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/mojos/AbstractAssemblyMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/mojos/AbstractAssemblyMojo.java?rev=1068108&r1=1068107&r2=1068108&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/mojos/AbstractAssemblyMojo.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/mojos/AbstractAssemblyMojo.java Mon Feb  7 20:34:57 2011
@@ -148,8 +148,11 @@ public abstract class AbstractAssemblyMo
     private String[] descriptors;
 
     /**
-     * A list of built-in descriptor references to generate from. You can select from <code>bin</code>,
-     * <code>jar-with-dependencies</code>, or <code>src</code>.
+     * A list of references to assembly descriptors available on the plugin's classpath. The default classpath
+     * includes these built-in descriptors: <code>bin</code>,
+     * <code>jar-with-dependencies</code>, <code>src</code>, and 
+     * <code>project</code>. You can add others by adding dependencies
+     * to the plugin.
      * 
      * @parameter
      */

Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo?rev=1068108&r1=1068107&r2=1068108&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo Mon Feb  7 20:34:57 2011
@@ -238,8 +238,14 @@
           <description>
             <![CDATA[
             Specifies the shared components xml file locations to include in the
-            assembly. The locations specified must be relative to the basedir of
-            the project. When multiple componentDescriptors are found, their
+            assembly. The locations specified must be relative to the base location
+            of the descriptor. If the descriptor was found via a &lt;descriptorRef/&gt; 
+            element in the
+            classpath, any components it specifies will also be found on the classpath.
+            If it is found by pathname via a &lt;descriptor/&gt; element 
+            the value here will be interpreted
+            as a path relative to the project basedir.
+            When multiple componentDescriptors are found, their
             contents are merged. Check out the <a href="component.html">
             descriptor components</a> for more information. A
             componentDescriptor is specified by providing one or more of