maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mper...@apache.org
Subject svn commit: r368547 - /maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo
Date Fri, 13 Jan 2006 01:51:18 GMT
Author: mperham
Date: Thu Jan 12 17:51:16 2006
New Revision: 368547

URL: http://svn.apache.org/viewcvs?rev=368547&view=rev
Log:
PR: MASSEMBLY-58
Submitted By: Tim O'Brien
Much improved descriptor documentation

Modified:
    maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo

Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo
URL: http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo?rev=368547&r1=368546&r2=368547&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 Thu Jan 12 17:51:16
2006
@@ -3,7 +3,24 @@
 <model>
   <id>assembly</id>
   <name>Assembly</name>
-  <description><![CDATA[Maven's model for the assembly descriptor.]]></description>
+  <description>
+    <![CDATA[
+	<p>
+	A definition of an assembly.  This descriptor specifies the 
+	type of assembly archive to create, the contents of the 
+	assembly, and the ways in which dependencies are bundled with
+	an assembly.
+	</p>
+	<p>
+	An assembly defines a collection of files usually distributed in an
+	archive format such as zip, tar, or tar.gz that is generated from a
+	project.  For example, a project could produce a ZIP assembly which
+	contains a project's JAR artifact in the root directory, the 
+	runtime dependencies in a lib/ directory, and a shell script to launch
+	a stand-alone application.
+	</p>
+    ]]>
+  </description>
   <defaults>
     <default>
       <key>package</key>
@@ -21,6 +38,10 @@
           <version>1.0.0</version>
           <required>true</required>
           <type>String</type>
+          <description>
+            The id of this assembly.  This is a symbolic name for a 
+            particular assembly of files from this project.
+          </description>
         </field>
         <field>
           <name>formats</name>
@@ -30,11 +51,32 @@
             <type>String</type>
             <multiplicity>*</multiplicity>
           </association>
+          <description>
+            <![CDATA[
+            Specify the formats of the assembly.  A format is specified by 
+            supplying one of the following values in a &lt;format&gt; subelement:
+            <ul>
+              <li><b>"zip"</b> - Creates a ZIP file format</li>
+              <li><b>"gz"</b> - Creates a GZIP format</li>
+              <li><b>"tar"</b> - Creates a TAR format</li>
+              <li><b>"tar.gz"</b> - Creates a gzip'd TAR format</li>
+              <li><b>"tar.bz2</b> - Creates a bzip'd TAR format</li>
+            </ul>
+            ]]>
+          </description>
         </field>
         <field>
           <name>includeBaseDirectory</name>
           <type>boolean</type>
           <defaultValue>true</defaultValue>
+          <description>
+            Includes a base directory in the final archive.  For example,
+            if you are creating an assembly named "your-app", setting
+            includeBaseDirectory to true will create an archive that
+            includes this base directory.  If this option is set to false
+            the archive created will unzip its content to the current
+            directory.
+          </description>
         </field>
         <field>
           <name>includeSiteDirectory</name>
@@ -48,6 +90,9 @@
             <type>FileSet</type>
             <multiplicity>*</multiplicity>
           </association>
+          <description>
+            Specify assembly parameters for groups of files. 
+          </description>
         </field>
         <field>
           <name>files</name>
@@ -56,8 +101,10 @@
             <type>FileItem</type>
             <multiplicity>*</multiplicity>
           </association>
+          <description>
+            Specify assembly parameters for single files.
+          </description>
         </field>
-
         <field>
           <name>dependencySets</name>
           <version>1.0.0</version>
@@ -65,6 +112,9 @@
             <type>DependencySet</type>
             <multiplicity>*</multiplicity>
           </association>
+          <description>
+            Specify assembly behavior for sets of dependencies.
+          </description>
         </field>
       </fields>
     </class>
@@ -76,6 +126,11 @@
           <name>outputDirectory</name>
           <version>1.0.0</version>
           <type>String</type>
+          <description>
+            Specifies the output directory relative to the root
+            of the root directory of the assembly.  For example,
+            "log" will put the specified files in the log directory.
+          </description>
         </field>
         <field>
           <name>includes</name>
@@ -84,6 +139,12 @@
             <type>String</type>
             <multiplicity>*</multiplicity>
           </association>
+          <description>
+            <![CDATA[
+            When &lt;include&gt; subelements are present, they define
+            a set of files and directory to include.
+            ]]>
+          </description>
         </field>
         <field>
           <name>excludes</name>
@@ -92,18 +153,42 @@
             <type>String</type>
             <multiplicity>*</multiplicity>
           </association>
+          <description>
+            <![CDATA[
+            When &lt;exclude&gt; subelements are present, they define
+            a set of files and directory to exclude.
+            ]]>
+          </description>
         </field>
         <field>
           <name>fileMode</name>
           <version>1.0.0</version>
           <type>String</type>
           <defaultValue>0644</defaultValue>
+          <description>
+            <![CDATA[
+            Similar to a UNIX permission.  Format: (User)(Group)(Other) where each
+            component is a sum of Read = 4, Write = 2, and Execute = 1.  For example,
+            the default value of 0644 translates to User read-write, Group and Other 
+            read-only. 
+            <a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
on unix-style permissions)</a>
+          	]]>
+          </description>
         </field>
         <field>
           <name>directoryMode</name>
           <version>1.0.0</version>
           <type>String</type>
           <defaultValue>0755</defaultValue>
+          <description>
+            <![CDATA[
+            Similar to a UNIX permission.  Format: (User)(Group)(Other) where each
+            component is a sum of Read = 4, Write = 2, and Execute = 1.  For example,
+            the default value of 0644 translates to User read-write, Group and Other 
+            read-only. 
+            <a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
on unix-style permissions)</a>
+          	]]>
+          </description>
         </field>
       </fields>
     </class>
@@ -116,54 +201,102 @@
           <name>directory</name>
           <version>1.0.0</version>
           <type>String</type>
-          <description>Absolute or relative from the module's directory.</description>
+          <description>
+            Absolute or relative from the module's directory.  For
+            example, "src/main/bin" would select this subdirectory
+            of the project in which this dependency is defined.
+          </description>
           <required>true</required>
         </field>
         <field>
           <name>lineEnding</name>
           <version>1.0.0</version>
           <type>String</type>
-          <!-- keep | unix | lf | dos | crlf -->
+          <description>
+            <![CDATA[
+            Controls the line-endings of files in this fileSet.
+            Valid values: 
+            <ul>
+              <li><b>"keep"</b> - Preserve all line endings</li>
+              <li><b>"unix"</b> - Use Unix-style line endings</li>
+              <li><b>"lf"</b> - Use a single line-feed line endings</li>
+              <li><b>"dos"</b> - Use DOS-style line endings</li>
+              <li><b>"crlf"</b> - Use Carraige-return, line-feed line endings</li>
+            </ul>
+            ]]>
+          </description>
         </field>
       </fields>
     </class>
     <class>
       <name>FileItem</name>
       <version>1.0.0</version>
-      <description>Allows individual file copy with option to change destination
-        file name not supported by fileSet</description>
+      <description>
+        Allows individual file copy with option to change destination
+        file name not supported by fileSet
+      </description>
       <fields>
         <field>
           <name>source</name>
           <version>1.0.0</version>
           <type>String</type>
-          <description>Absolute or relative from the module's directory.</description>
           <required>true</required>
+          <description>
+            Absolute or relative from the module's directory.
+          </description>
         </field>
         <field>
           <name>outputDirectory</name>
           <version>1.0.0</version>
           <type>String</type>
-          <description>Relative to root archive.</description>
           <required>false</required>
+          <description>
+            Specifies the output directory relative to the root
+            of the root directory of the assembly.  For example,
+            "log" will put the specified files in the log directory.
+          </description>
         </field>
         <field>
           <name>destName</name>
           <version>1.0.0</version>
           <type>String</type>
-          <description>Destination file name in outputDirectory. Default is source's
file name</description>
+          <description>
+            Destination file name in outputDirectory. 
+            Default is the same name as the source's file.
+          </description>
         </field>
         <field>
           <name>fileMode</name>
           <version>1.0.0</version>
           <type>String</type>
           <defaultValue>0644</defaultValue>
+          <description>
+            <![CDATA[
+            Similar to a UNIX permission.  Format: (User)(Group)(Other) where each
+            component is a sum of Read = 4, Write = 2, and Execute = 1.  For example,
+            the default value of 0644 translates to User read-write, Group and Other 
+            read-only. 
+            <a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
on unix-style permissions)</a>
+          	]]>
+          </description>
         </field>
         <field>
           <name>lineEnding</name>
           <version>1.0.0</version>
           <type>String</type>
-          <!-- keep | unix | lf | dos | crlf -->
+          <description>
+            <![CDATA[
+            Controls the line-endings of files in this fileSet.
+            Valid values are: 
+            <ul>
+              <li><b>"keep"</b> - Preserve all line endings</li>
+              <li><b>"unix"</b> - Use Unix-style line endings</li>
+              <li><b>"lf"</b> - Use a single line-feed line endings</li>
+              <li><b>"dos"</b> - Use DOS-style line endings</li>
+              <li><b>"crlf"</b> - Use Carraige-return, line-feed line endings</li>
+            </ul>
+            ]]>
+          </description>
         </field>
       </fields>
     </class>
@@ -172,17 +305,29 @@
       <name>DependencySet</name>
       <version>1.0.0</version>
       <superClass>SetBase</superClass>
+      <description>Defines a dependency set</description>
       <fields>
         <field>
           <name>outputFileNameMapping</name>
           <version>1.0.0</version>
           <type>String</type>
           <defaultValue>${artifactId}-${version}.${extension}</defaultValue>
+          <description>
+            Specify the mapping pattern for all dependencies included 
+            in this assembly.
+            Default is ${artifactId}-${version}.${extension}.
+          </description>
         </field>
         <field>
           <name>unpack</name>
           <type>boolean</type>
           <defaultValue>false</defaultValue>
+          <description>
+            If set to true, this property will unpack all dependencies
+            into the specified output directory.  When set to false
+            dependencies will be includes as archives (jars).
+            Default value is false.
+          </description>
         </field>
         <field>
           <name>scope</name>
@@ -190,6 +335,10 @@
           <type>String</type>
           <defaultValue>runtime</defaultValue>
           <required>true</required>
+          <description>
+            Specifies the dependency scope for this dependencySet.
+            Default scope value is "runtime".
+          </description>
         </field>
       </fields>
     </class>



Mime
View raw message