maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jdca...@apache.org
Subject svn commit: r431529 - /maven/shared/trunk/file-management/src/main/mdo/fileset.mdo
Date Tue, 15 Aug 2006 04:52:48 GMT
Author: jdcasey
Date: Mon Aug 14 21:52:48 2006
New Revision: 431529

URL: http://svn.apache.org/viewvc?rev=431529&view=rev
Log:
Fixing documentation inline within modello file.

Modified:
    maven/shared/trunk/file-management/src/main/mdo/fileset.mdo

Modified: maven/shared/trunk/file-management/src/main/mdo/fileset.mdo
URL: http://svn.apache.org/viewvc/maven/shared/trunk/file-management/src/main/mdo/fileset.mdo?rev=431529&r1=431528&r2=431529&view=diff
==============================================================================
--- maven/shared/trunk/file-management/src/main/mdo/fileset.mdo (original)
+++ maven/shared/trunk/file-management/src/main/mdo/fileset.mdo Mon Aug 14 21:52:48 2006
@@ -174,28 +174,54 @@
           <type>String</type>
           <defaultValue>identity</defaultValue>
           <description>
-            specifies one of the built-in mapper implementations. A custom mapper may be
specified by using the classname property.
-            If classname is being used, then the type should not be used.
             <![CDATA[ 
+            Specifies a built-in mapper implementation.
+            <br/>
             Valid values:
             <ul>
-              <li><b>"flatten"</b> - The target file name is identical
to the source file name, with all leading directory information stripped off. Both to and
from will be ignored </li>
-              <li><b>"glob"</b> - Both to and from define patterns that
may contain at most one *. For each source file that matches the from pattern, a target file
name will be constructed from the to pattern by substituting the * in the to pattern with
the text that matches the * in the from pattern. Source file names that don't match the from
pattern will be ignored/li>
-              <li><b>"regexp"</b> - Both to and from define regular expressions.
If the source file name matches the from pattern, the target file name will be constructed
from the to pattern, using \0 to \9 as back-references for the full match (\0) or the matches
of the subexpressions in parentheses. Source files not matching the from pattern will be ignored.</li>
-              <li><b>"merge"</b> - The target file name will always be
the same, as defined by to. from will be ignored</li>
-              <li><b>"package"</b> - Sharing the same syntax as the glob
mapper, the package mapper replaces directory separators found in the matched source pattern
with dots in the target pattern placeholder. This mapper is particularly useful in combination
with <uptodate> and <junit> output. </li>
-              <li><b>"unpackage"</b> - This mapper is the inverse of the
package mapper. It replaces the dots in a package name with directory separators. This is
useful for matching XML formatter results against their JUnit test test cases. The mapper
shares the sample syntax as the glob mapper. </li>
+              <li><b>"flatten"</b> - 
+                  The target file name is identical to the source file name, with all leading

+                  directory information stripped off. Both to and from will be ignored.
+              </li>
+              <li><b>"glob"</b> - 
+                  Both to and from define patterns that may contain at most one *. For each
source 
+                  file that matches the from pattern, a target file name will be constructed
from 
+                  the to pattern by substituting the * in the to pattern with the text that
matches 
+                  the * in the from pattern. Source file names that don't match the from
pattern 
+                  will be ignored.
+              </li>
+              <li><b>"regexp"</b> - 
+                  Both to and from define regular expressions. If the source file name matches
the 
+                  from pattern, the target file name will be constructed from the to pattern,
using 
+                  \0 to \9 as back-references for the full match (\0) or the matches of the

+                  subexpressions in parentheses. Source files not matching the from pattern
will be 
+                  ignored.
+              </li>
+              <li><b>"merge"</b> - 
+                  The target file name will always be the same, as defined by to. from will
be 
+                  ignored.
+              </li>
+              <li><b>"package"</b> - 
+                  Sharing the same syntax as the glob mapper, the package mapper replaces
directory 
+                  separators found in the matched source pattern with dots in the target
pattern 
+                  placeholder.
+              </li>
+              <li><b>"unpackage"</b> - 
+                  This mapper is the inverse of the package mapper. It replaces the dots
in a 
+                  package name with directory separators. This is useful for matching XML
formatter 
+                  results against their JUnit test test cases. The mapper shares the sample
syntax 
+                  as the glob mapper.
+              </li>
             </ul>
             ]]>
           </description>
-          <required>true</required>
         </field>
         <field>
           <name>from</name>
           <version>1.1.0</version>
           <type>String</type>
           <description>
-          the from attribute for the given implementation. Depends on the implementation
+    	      	Specifies a type-specific pattern for matching source paths which should be mapped.
           </description>
         </field>
         <field>
@@ -203,7 +229,7 @@
           <version>1.1.0</version>
           <type>String</type>
           <description>
-          the to attribute for the given implementation. Depends on the implementation
+	        Specifies a type-specific pattern for producing paths based on source paths.
           </description>
         </field>
         <field>
@@ -211,8 +237,9 @@
           <version>1.1.0</version>
           <type>String</type>
           <description>
-          Specify your own implementation of the mapper. The class has to be in the classpath
of the project. 
-          Do not specify the classname if the type is used.
+	        Allows specification of a custom mapper implementation. The class must be of type
+	        org.apache.maven.shared.model.fileset.mappers.FileNameMapper, from the artifact
+	        org.apache.maven.shared:file-management.
           </description>
         </field>
       </fields>



Mime
View raw message