You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by jd...@apache.org on 2010/09/27 22:59:34 UTC
svn commit: r1001908 - in /maven/plugins/trunk/maven-assembly-plugin/src:
it/projects/basic-features/local-repo-interp/
main/java/org/apache/maven/plugin/assembly/archive/phase/ main/mdo/
site/apt/examples/multimodule/
Author: jdcasey
Date: Mon Sep 27 20:59:33 2010
New Revision: 1001908
URL: http://svn.apache.org/viewvc?rev=1001908&view=rev
Log:
[MASSEMBLY-140][MASSEMBLY-229] Improve the component / descriptors to avoid incorrect cross-pollution from SetBase. In the process, adjust the documentation for includes/excludes of various parts, and adjust documentation for file/directory mode.
Removed:
maven/plugins/trunk/maven-assembly-plugin/src/it/projects/basic-features/local-repo-interp/goals.txt
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/RepositoryAssemblyPhase.java
maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo
maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt.vm
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/RepositoryAssemblyPhase.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/RepositoryAssemblyPhase.java?rev=1001908&r1=1001907&r2=1001908&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/RepositoryAssemblyPhase.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/RepositoryAssemblyPhase.java Mon Sep 27 20:59:33 2010
@@ -118,7 +118,6 @@ public class RepositoryAssemblyPhase
task.setFileMode( fileMode );
}
- task.setUseDefaultExcludes( repository.isUseDefaultExcludes() );
task.setOutputDirectory( outputDirectory );
task.execute( archiver, configSource );
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo?rev=1001908&r1=1001907&r2=1001908&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo Mon Sep 27 20:59:33 2010
@@ -146,9 +146,13 @@
</fields>
</class>
+ <!-- Shared with component descriptor from here on. -->
<class>
- <name>SetBase</name>
+ <name>FileSet</name>
<version>1.0.0+</version>
+ <description>
+ A fileSet allows the inclusion of groups of files into the assembly.
+ </description>
<fields>
<field>
<name>useDefaultExcludes</name>
@@ -158,7 +162,7 @@
<description>
Whether standard exclusion patterns, such as those matching CVS and Subversion
metadata files, should be used when calculating the files affected by this set.
- For backward compatibility, the default value is true.
+ For backward compatibility, the default value is true. (Since 2.2)
</description>
</field>
<field>
@@ -211,6 +215,7 @@
<description>
<![CDATA[
Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only.
@@ -228,23 +233,15 @@
<description>
<![CDATA[
Similar to a UNIX permission, sets the directory mode of the directories
- included. Format: (User)(Group)(Other) where each component is a sum of
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
Read = 4, Write = 2, and Execute = 1. For example, the value
0755 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>
- <class>
- <name>FileSet</name>
- <version>1.0.0+</version>
- <superClass>SetBase</superClass>
- <description>
- A fileSet allows the inclusion of groups of files into the assembly.
- </description>
- <fields>
<field>
<name>directory</name>
<version>1.0.0+</version>
@@ -279,7 +276,7 @@
<version>1.1.0+</version>
<description>
Whether to filter symbols in the files as they are copied, using
- properties from the build configuration.
+ properties from the build configuration. (Since 2.2)
</description>
<defaultValue>false</defaultValue>
<type>boolean</type>
@@ -334,6 +331,7 @@
<description>
<![CDATA[
Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only.
@@ -373,13 +371,98 @@
<class>
<name>DependencySet</name>
<version>1.0.0+</version>
- <superClass>SetBase</superClass>
<description>
A dependencySet allows inclusion and exclusion of project dependencies
in the assembly.
</description>
<fields>
<field>
+ <name>outputDirectory</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <description>
+ Sets 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,
+ directly beneath the root of the archive.
+ </description>
+ </field>
+ <field>
+ <name>includes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <include> subelements are present, they define a set of
+ artifact coordinates to include. If none is present, then
+ <includes> represents all valid values.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ dependency artifact coordinates to exclude. If none is present, then
+ <excludes> represents no exclusions.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>fileMode</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0644</defaultValue>
+ -->
+ <description>
+ <![CDATA[
+ Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of Read = 4,
+ Write = 2, and Execute = 1. For example, the value 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, sets the directory mode of the directories
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
+ Read = 4, Write = 2, and Execute = 1. For example, the value
+ 0755 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>useStrictFiltering</name>
<version>1.1.2+</version>
<type>boolean</type>
@@ -397,22 +480,21 @@
<type>String</type>
<defaultValue>${artifact.artifactId}-${artifact.version}${dashClassifier?}.${artifact.extension}</defaultValue>
<description>
- Sets the mapping pattern for all NON-UNPACKED dependencies included in this
+ Sets the mapping pattern for all dependencies included in this
assembly. Default is ${artifact.artifactId}-${artifact.version}${dashClassifier?}.${artifact.extension}.
- If the artifact doesn't have a classifier, that part of the pattern will be left off.
- (Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension}) NOTE: If the
- dependencySet specifies unpack == true, outputFileNameMapping WILL NOT BE USED; in these cases, use outputDirectory.
+ (Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension})
</description>
</field>
<field>
<name>unpack</name>
+ <version>1.0.0+</version>
<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.
+ dependencies will be includes as archives (jars). Can only unpack
+ jar, zip, tar.gz, and tar.bz archives. Default value is false.
</description>
</field>
<field>
@@ -420,7 +502,7 @@
<version>1.1.0+</version>
<description>
Allows the specification of includes and excludes, along with filtering options, for items
- unpacked from a dependency artifact.
+ unpacked from a dependency artifact. (Since 2.2)
</description>
<association>
<type>UnpackOptions</type>
@@ -428,7 +510,7 @@
</field>
<field>
<name>scope</name>
- <version>1.0.0+</version>
+ <version>1.0.0+</version>
<type>String</type>
<defaultValue>runtime</defaultValue>
<required>true</required>
@@ -491,141 +573,113 @@
</class>
<class>
- <name>Repository</name>
- <version>1.1.0+</version>
- <superClass>SetBase</superClass>
- <description>Defines a Maven repository to be included in the assembly.</description>
+ <name>ModuleSet</name>
+ <description>
+ <![CDATA[
+ A moduleSet represent one or more project <module> present inside
+ a project's pom.xml. This allows you to include sources or binaries
+ belonging to a project's <modules>.
+
+ <br/><b>NOTE:</b> When using <moduleSets> from the command-line, it
+ is required to pass first the package phase by doing: "mvn package
+ assembly:assembly". This bug/issue is scheduled to be addressed by Maven 2.1.
+ ]]>
+ </description>
+ <version>1.1.2+</version>
<fields>
<field>
- <name>includeMetadata</name>
- <version>1.1.0+</version>
+ <name>useAllReactorProjects</name>
+ <version>1.1.2+</version>
<type>boolean</type>
<defaultValue>false</defaultValue>
<description>
- If set to true, this property will trigger the creation of repository
- metadata which will allow the repository to be used as a functional remote
- repository.
+ If set to true, the plugin will include all projects in the current reactor for processing
+ in this ModuleSet. These will be subject to include/exclude rules.
+ Default value is true. (Since 2.2-beta-6)
</description>
</field>
<field>
- <name>groupVersionAlignments</name>
- <version>1.1.0+</version>
- <description>Align a group to a version or an individual artifact.</description>
- <association>
- <type>GroupVersionAlignment</type>
- <multiplicity>*</multiplicity>
- </association>
- </field>
- <field>
- <name>scope</name>
- <version>1.1.0+</version>
- <type>String</type>
- <defaultValue>runtime</defaultValue>
- <required>true</required>
+ <name>includeSubModules</name>
+ <version>1.1.2+</version>
+ <type>boolean</type>
+ <defaultValue>true</defaultValue>
<description>
- Specifies the scope for artifacts included in this repository.
- Default scope value is "runtime".
+ If set to false, the plugin will exclude sub-modules from processing in this ModuleSet.
+ Otherwise, it will process all sub-modules, each subject to include/exclude rules.
+ Default value is true. (Since 2.2)
</description>
</field>
- </fields>
- </class>
- <class>
- <name>GroupVersionAlignment</name>
- <version>1.1.0+</version>
- <description>Defines a Maven repository to be included in the assembly.</description>
- <fields>
- <field>
- <name>id</name>
- <version>1.1.0+</version>
- <type>String</type>
- <description>The groupId for which you want to align the versions.</description>
- </field>
- <field>
- <name>version</name>
- <version>1.1.0+</version>
- <type>String</type>
- <description>The version you want to align this group to.</description>
- </field>
<field>
- <name>excludes</name>
- <version>1.1.0+</version>
- <description>Artifact Ids of the artifacts you want excluded from version alignment.</description>
+ <name>includes</name>
+ <version>1.1.2+</version>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
</association>
- </field>
- </fields>
- </class>
- <class>
- <name>UnpackOptions</name>
- <version>1.1.0+</version>
- <description>
- Specifies options for including/excluding/filtering items extracted from an archive.
- </description>
- <fields>
- <field>
- <name>includes</name>
- <version>1.1.0+</version>
<description>
- Set of patterns for matching items to be included from an archive as it is unpacked.
+ <![CDATA[
+ When <include> subelements are present, they define a set of
+ project coordinates to include. If none is present, then
+ <includes> represents all valid values.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
</description>
- <association>
- <type>String</type>
- <multiplicity>*</multiplicity>
- </association>
</field>
<field>
<name>excludes</name>
- <version>1.1.0+</version>
- <description>
- Set of patterns for matching items to be excluded from an archive as it is unpacked.
- </description>
+ <version>1.1.2+</version>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
</association>
- </field>
- <field>
- <name>filtered</name>
- <version>1.1.0+</version>
<description>
- Whether to filter symbols in the files as they are unpacked from the archive, using
- properties from the build configuration.
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ project artifact coordinates to exclude. If none is present, then
+ <excludes> represents no exclusions.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
</description>
- <defaultValue>false</defaultValue>
- <type>boolean</type>
</field>
<field>
- <name>lineEnding</name>
+ <name>sources</name>
<version>1.1.2+</version>
- <type>String</type>
<description>
- <![CDATA[
- Sets the line-endings of the files. (Since 2.2)
- 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>
- ]]>
+ When this is present, the plugin will include the source files of
+ the included modules from this set in the resulting assembly.
</description>
+ <association>
+ <type>ModuleSources</type>
+ </association>
</field>
<field>
- <name>useStrictFiltering</name>
+ <name>binaries</name>
<version>1.1.2+</version>
- <type>boolean</type>
- <defaultValue>false</defaultValue>
<description>
- When specified as true, any include/exclude patterns which aren't used to filter an actual
- artifact during assembly creation will cause the build to fail with an error. This is meant
- to highlight obsolete inclusions or exclusions, or else signal that the assembly descriptor
- is incorrectly configured. (Since 2.2)
+ When this is present, the plugin will include the binaries of the
+ included modules from this set in the resulting assembly.
</description>
+ <association>
+ <type>ModuleBinaries</type>
+ </association>
</field>
+ </fields>
+ </class>
+
+ <class>
+ <name>ModuleSources</name>
+ <version>1.1.2+</version>
+ <description>
+ Contains configuration options for including the source files of a
+ project module in an assembly.
+ </description>
+ <fields>
<field>
<name>useDefaultExcludes</name>
<version>1.1.2+</version>
@@ -637,138 +691,83 @@
For backward compatibility, the default value is true. (Since 2.2)
</description>
</field>
- </fields>
- </class>
- <class>
- <name>ContainerDescriptorHandlerConfig</name>
- <version>1.1.0+</version>
- <description>
- Configures a filter for files headed into the assembly archive, to enable
- aggregation of various types of descriptor fragments, such as components.xml,
- web.xml, etc.
- </description>
- <fields>
<field>
- <name>handlerName</name>
- <version>1.1.0+</version>
+ <name>outputDirectory</name>
+ <version>1.1.2+</version>
+ <type>String</type>
<description>
- The handler's plexus role-hint, for lookup from the container.
- </description>
- <type>String</type>
- <required>true</required>
- </field>
- <field>
- <name>configuration</name>
- <version>1.1.1+</version>
- <description>
- Configuration options for the handler.
- </description>
- <type>DOM</type>
- </field>
- </fields>
- </class>
- <class>
- <name>ModuleSet</name>
- <description>
- <![CDATA[
- A moduleSet represent one or more project <module> present inside
- a project's pom.xml. This allows you to include sources or binaries
- belonging to a project's <modules>.
-
- <br/><b>NOTE:</b> When using <moduleSets> from the command-line, it
- is required to pass first the package phase by doing: "mvn package
- assembly:assembly". This bug/issue is scheduled to be addressed by Maven 2.1.
- ]]>
- </description>
- <version>1.0.0+</version>
- <fields>
- <field>
- <name>useAllReactorProjects</name>
- <version>1.1.2+</version>
- <type>boolean</type>
- <defaultValue>false</defaultValue>
- <description>
- If set to true, the plugin will include all projects in the current reactor for processing
- in this ModuleSet. These will be subject to include/exclude rules.
- Default value is true. (Since 2.2-beta-6)
- </description>
- </field>
- <field>
- <name>includeSubModules</name>
- <version>1.1.2+</version>
- <type>boolean</type>
- <defaultValue>true</defaultValue>
- <description>
- If set to false, the plugin will exclude sub-modules from processing in this ModuleSet.
- Otherwise, it will process all sub-modules, each subject to include/exclude rules.
- Default value is true. (Since 2.2)
+ Sets 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>
<version>1.1.2+</version>
- <description>
- <![CDATA[
- This is a list of <include/> subelements, each containing a
- module reference of the type groupId:artifactId. Modules matching
- these elements will be included in this set. If none is present,
- then <includes> represents all valid values.
- ]]>
- </description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
</association>
- </field>
- <field>
- <name>excludes</name>
- <version>1.1.2+</version>
<description>
<![CDATA[
- This is a list of <exclude/> subelements, each containing a
- module reference of the type groupId:artifactId. Modules matching
- these elements will be excluded from this set.
+ When <include> subelements are present, they define a set of
+ files and directory to include. If none is present, then
+ <includes> represents all valid values.
]]>
</description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.1.2+</version>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
</association>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ files and directory to exclude. If none is present, then
+ <excludes> represents no exclusions.
+ ]]>
+ </description>
</field>
<field>
- <name>sources</name>
+ <name>fileMode</name>
<version>1.1.2+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0644</defaultValue>
+ -->
<description>
- When this is present, the plugin will include the source files of
- the included modules from this set in the resulting assembly.
+ <![CDATA[
+ Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of Read = 4,
+ Write = 2, and Execute = 1. For example, the value 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>
- <association>
- <type>ModuleSources</type>
- </association>
</field>
<field>
- <name>binaries</name>
+ <name>directoryMode</name>
<version>1.1.2+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0755</defaultValue>
+ -->
<description>
- When this is present, the plugin will include the binaries of the
- included modules from this set in the resulting assembly.
+ <![CDATA[
+ Similar to a UNIX permission, sets the directory mode of the directories
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
+ Read = 4, Write = 2, and Execute = 1. For example, the value
+ 0755 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>
- <association>
- <type>ModuleBinaries</type>
- </association>
</field>
- </fields>
- </class>
-
- <class>
- <name>ModuleSources</name>
- <version>1.1.2+</version>
- <superClass>SetBase</superClass>
- <description>
- Contains configuration options for including the source files of a
- project module in an assembly.
- </description>
- <fields>
<field>
<name>fileSets</name>
<version>1.1.2+</version>
@@ -823,17 +822,102 @@
</field>
</fields>
</class>
-
+
<class>
<name>ModuleBinaries</name>
<version>1.1.2+</version>
- <superClass>SetBase</superClass>
<description>
Contains configuration options for including the binary files of a
project module in an assembly.
</description>
<fields>
<field>
+ <name>outputDirectory</name>
+ <version>1.1.2+</version>
+ <type>String</type>
+ <description>
+ Sets 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,
+ directly beneath the root of the archive.
+ </description>
+ </field>
+ <field>
+ <name>includes</name>
+ <version>1.1.2+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <include> subelements are present, they define a set of
+ artifact coordinates to include. If none is present, then
+ <includes> represents all valid values.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.1.2+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ dependency artifact coordinates to exclude. If none is present, then
+ <excludes> represents no exclusions.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>fileMode</name>
+ <version>1.1.2+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0644</defaultValue>
+ -->
+ <description>
+ <![CDATA[
+ Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of Read = 4,
+ Write = 2, and Execute = 1. For example, the value 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.1.2+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0755</defaultValue>
+ -->
+ <description>
+ <![CDATA[
+ Similar to a UNIX permission, sets the directory mode of the directories
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
+ Read = 4, Write = 2, and Execute = 1. For example, the value
+ 0755 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>attachmentClassifier</name>
<version>1.1.2+</version>
<type>String</type>
@@ -908,6 +992,291 @@
</field>
</fields>
</class>
+
+ <class>
+ <name>Repository</name>
+ <version>1.0.0+</version>
+ <description>
+ <![CDATA[
+ Defines a Maven repository to be included in the assembly. The artifacts
+ available to be included in a repository are your project's dependency
+ artifacts. The repository created contains the needed metadata entries
+ and also contains both sha1 and md5 checksums. This is useful for creating
+ archives which will be deployed to internal repositories.
+
+ <br/><b>NOTE:</b> Currently, only artifacts from the central repository
+ are allowed.
+ ]]>
+ </description>
+ <fields>
+ <field>
+ <name>outputDirectory</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <description>
+ Sets 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,
+ directly beneath the root of the archive.
+ </description>
+ </field>
+ <field>
+ <name>includes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <include> subelements are present, they define a set of
+ artifact coordinates to include. If none is present, then
+ <includes> represents all valid values.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ dependency artifact coordinates to exclude. If none is present, then
+ <excludes> represents no exclusions.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>fileMode</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0644</defaultValue>
+ -->
+ <description>
+ <![CDATA[
+ Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of Read = 4,
+ Write = 2, and Execute = 1. For example, the value 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, sets the directory mode of the directories
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
+ Read = 4, Write = 2, and Execute = 1. For example, the value
+ 0755 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>includeMetadata</name>
+ <version>1.0.0+</version>
+ <type>boolean</type>
+ <defaultValue>false</defaultValue>
+ <description>
+ If set to true, this property will trigger the creation of repository
+ metadata which will allow the repository to be used as a functional remote
+ repository. Default value is false.
+ </description>
+ </field>
+ <field>
+ <name>groupVersionAlignments</name>
+ <version>1.0.0+</version>
+ <description>
+ <![CDATA[
+ Specifies that you want to align a group of artifacts to a specified
+ version. A groupVersionAlignment is specified by providing one or
+ more of <groupVersionAlignment> subelements.
+ ]]>
+ </description>
+ <association>
+ <type>GroupVersionAlignment</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ </field>
+ <field>
+ <name>scope</name>
+ <version>1.1.0+</version>
+ <type>String</type>
+ <defaultValue>runtime</defaultValue>
+ <required>true</required>
+ <description>
+ Specifies the scope for artifacts included in this repository.
+ Default scope value is "runtime". (Since 2.2)
+ </description>
+ </field>
+ </fields>
+ </class>
+ <class>
+ <name>GroupVersionAlignment</name>
+ <version>1.0.0+</version>
+ <description>
+ Allows a group of artifacts to be aligned to a specified version.
+ </description>
+ <fields>
+ <field>
+ <name>id</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <description>
+ The groupId of the artifacts for which you want to align the
+ versions.
+ </description>
+ </field>
+ <field>
+ <name>version</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <description>
+ The version you want to align this group to.
+ </description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.0.0+</version>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define the
+ artifactIds of the artifacts to exclude. If none is present, then
+ <excludes> represents no exclusions. An exclude is specified
+ by providing one or more of <exclude> subelements.
+ ]]>
+ </description>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ </field>
+ </fields>
+ </class>
+ <class>
+ <name>UnpackOptions</name>
+ <version>1.1.0+</version>
+ <description>
+ Specifies options for including/excluding/filtering items extracted from an archive. (Since 2.2)
+ </description>
+ <fields>
+ <field>
+ <name>includes</name>
+ <version>1.1.0+</version>
+ <description>
+ <![CDATA[
+ Set of file and/or directory patterns for matching items to be included from an archive as it is unpacked. (Since 2.2)
+ ]]>
+ </description>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.1.0+</version>
+ <description>
+ <![CDATA[
+ Set of file and/or directory patterns for matching items to be excluded from an archive as it is unpacked. (Since 2.2)
+ ]]>
+ </description>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ </field>
+ <field>
+ <name>filtered</name>
+ <version>1.1.0+</version>
+ <description>
+ Whether to filter symbols in the files as they are unpacked from the archive, using
+ properties from the build configuration. (Since 2.2)
+ </description>
+ <defaultValue>false</defaultValue>
+ <type>boolean</type>
+ </field>
+ <field>
+ <name>lineEnding</name>
+ <version>1.1.2+</version>
+ <type>String</type>
+ <description>
+ <![CDATA[
+ Sets the line-endings of the files. (Since 2.2)
+ 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>
+ <field>
+ <name>useDefaultExcludes</name>
+ <version>1.1.2+</version>
+ <type>boolean</type>
+ <defaultValue>true</defaultValue>
+ <description>
+ Whether standard exclusion patterns, such as those matching CVS and Subversion
+ metadata files, should be used when calculating the files affected by this set.
+ For backward compatibility, the default value is true. (Since 2.2)
+ </description>
+ </field>
+ </fields>
+ </class>
+ <class>
+ <name>ContainerDescriptorHandlerConfig</name>
+ <version>1.1.0+</version>
+ <description>
+ Configures a filter for files headed into the assembly archive, to enable
+ aggregation of various types of descriptor fragments, such as components.xml,
+ web.xml, etc.
+ </description>
+ <fields>
+ <field>
+ <name>handlerName</name>
+ <version>1.1.0+</version>
+ <description>
+ The handler's plexus role-hint, for lookup from the container.
+ </description>
+ <type>String</type>
+ <required>true</required>
+ </field>
+ <field>
+ <name>configuration</name>
+ <version>1.1.1+</version>
+ <description>
+ Configuration options for the handler.
+ </description>
+ <type>DOM</type>
+ </field>
+ </fields>
+ </class>
</classes>
</model>
-
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=1001908&r1=1001907&r2=1001908&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 Sep 27 20:59:33 2010
@@ -249,10 +249,13 @@
</fields>
</class>
-
+ <!-- Shared with component descriptor from here on. -->
<class>
- <name>SetBase</name>
+ <name>FileSet</name>
<version>1.0.0+</version>
+ <description>
+ A fileSet allows the inclusion of groups of files into the assembly.
+ </description>
<fields>
<field>
<name>useDefaultExcludes</name>
@@ -315,6 +318,7 @@
<description>
<![CDATA[
Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only.
@@ -332,23 +336,15 @@
<description>
<![CDATA[
Similar to a UNIX permission, sets the directory mode of the directories
- included. Format: (User)(Group)(Other) where each component is a sum of
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
Read = 4, Write = 2, and Execute = 1. For example, the value
0755 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>
- <class>
- <name>FileSet</name>
- <version>1.0.0+</version>
- <superClass>SetBase</superClass>
- <description>
- A fileSet allows the inclusion of groups of files into the assembly.
- </description>
- <fields>
<field>
<name>directory</name>
<version>1.0.0+</version>
@@ -438,6 +434,7 @@
<description>
<![CDATA[
Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only.
@@ -477,13 +474,98 @@
<class>
<name>DependencySet</name>
<version>1.0.0+</version>
- <superClass>SetBase</superClass>
<description>
A dependencySet allows inclusion and exclusion of project dependencies
in the assembly.
</description>
<fields>
<field>
+ <name>outputDirectory</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <description>
+ Sets 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,
+ directly beneath the root of the archive.
+ </description>
+ </field>
+ <field>
+ <name>includes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <include> subelements are present, they define a set of
+ artifact coordinates to include. If none is present, then
+ <includes> represents all valid values.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ dependency artifact coordinates to exclude. If none is present, then
+ <excludes> represents no exclusions.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>fileMode</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0644</defaultValue>
+ -->
+ <description>
+ <![CDATA[
+ Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of Read = 4,
+ Write = 2, and Execute = 1. For example, the value 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, sets the directory mode of the directories
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
+ Read = 4, Write = 2, and Execute = 1. For example, the value
+ 0755 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>useStrictFiltering</name>
<version>1.1.2+</version>
<type>boolean</type>
@@ -633,33 +715,40 @@
<field>
<name>includes</name>
<version>1.0.0+</version>
- <description>
- <![CDATA[
- This is a list of <include/> subelements, each containing a
- module reference of the type groupId:artifactId. Modules matching
- these elements will be included in this set. If none is present,
- then <includes> represents all valid values.
- ]]>
- </description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
</association>
- </field>
- <field>
- <name>excludes</name>
- <version>1.0.0+</version>
<description>
<![CDATA[
- This is a list of <exclude/> subelements, each containing a
- module reference of the type groupId:artifactId. Modules matching
- these elements will be excluded from this set.
+ When <include> subelements are present, they define a set of
+ project coordinates to include. If none is present, then
+ <includes> represents all valid values.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
]]>
</description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.0.0+</version>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
</association>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ project artifact coordinates to exclude. If none is present, then
+ <excludes> represents no exclusions.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
</field>
<field>
<name>sources</name>
@@ -689,13 +778,100 @@
<class>
<name>ModuleSources</name>
<version>1.0.0+</version>
- <superClass>SetBase</superClass>
<description>
Contains configuration options for including the source files of a
project module in an assembly.
</description>
<fields>
<field>
+ <name>useDefaultExcludes</name>
+ <version>1.1.0+</version>
+ <type>boolean</type>
+ <defaultValue>true</defaultValue>
+ <description>
+ Whether standard exclusion patterns, such as those matching CVS and Subversion
+ metadata files, should be used when calculating the files affected by this set.
+ For backward compatibility, the default value is true. (Since 2.2)
+ </description>
+ </field>
+ <field>
+ <name>outputDirectory</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <description>
+ Sets 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>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <include> subelements are present, they define a set of
+ files and directory to include. If none is present, then
+ <includes> represents all valid values.
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ files and directory to exclude. If none is present, then
+ <excludes> represents no exclusions.
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>fileMode</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0644</defaultValue>
+ -->
+ <description>
+ <![CDATA[
+ Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of Read = 4,
+ Write = 2, and Execute = 1. For example, the value 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, sets the directory mode of the directories
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
+ Read = 4, Write = 2, and Execute = 1. For example, the value
+ 0755 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>fileSets</name>
<version>1.1.0+</version>
<association>
@@ -753,13 +929,98 @@
<class>
<name>ModuleBinaries</name>
<version>1.0.0+</version>
- <superClass>SetBase</superClass>
<description>
Contains configuration options for including the binary files of a
project module in an assembly.
</description>
<fields>
<field>
+ <name>outputDirectory</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <description>
+ Sets 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,
+ directly beneath the root of the archive.
+ </description>
+ </field>
+ <field>
+ <name>includes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <include> subelements are present, they define a set of
+ artifact coordinates to include. If none is present, then
+ <includes> represents all valid values.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ dependency artifact coordinates to exclude. If none is present, then
+ <excludes> represents no exclusions.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>fileMode</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0644</defaultValue>
+ -->
+ <description>
+ <![CDATA[
+ Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of Read = 4,
+ Write = 2, and Execute = 1. For example, the value 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, sets the directory mode of the directories
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
+ Read = 4, Write = 2, and Execute = 1. For example, the value
+ 0755 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>attachmentClassifier</name>
<version>1.1.0+</version>
<type>String</type>
@@ -838,7 +1099,6 @@
<class>
<name>Repository</name>
<version>1.0.0+</version>
- <superClass>SetBase</superClass>
<description>
<![CDATA[
Defines a Maven repository to be included in the assembly. The artifacts
@@ -853,6 +1113,92 @@
</description>
<fields>
<field>
+ <name>outputDirectory</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <description>
+ Sets 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,
+ directly beneath the root of the archive.
+ </description>
+ </field>
+ <field>
+ <name>includes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <include> subelements are present, they define a set of
+ artifact coordinates to include. If none is present, then
+ <includes> represents all valid values.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>excludes</name>
+ <version>1.0.0+</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>
+ <![CDATA[
+ When <exclude> subelements are present, they define a set of
+ dependency artifact coordinates to exclude. If none is present, then
+ <excludes> represents no exclusions.
+
+ Artifact coordinatess may be given in simple groupId:artifactId form,
+ or they may be fully qualified in the form groupId:artifactId:type:version[:classifier].
+ Additionally, wildcards can be used, as in *:maven-*
+ ]]>
+ </description>
+ </field>
+ <field>
+ <name>fileMode</name>
+ <version>1.0.0+</version>
+ <type>String</type>
+ <!--
+ <defaultValue>0644</defaultValue>
+ -->
+ <description>
+ <![CDATA[
+ Similar to a UNIX permission, sets the file mode of the files included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of Read = 4,
+ Write = 2, and Execute = 1. For example, the value 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, sets the directory mode of the directories
+ included.
+ THIS IS AN OCTAL VALUE.
+ Format: (User)(Group)(Other) where each component is a sum of
+ Read = 4, Write = 2, and Execute = 1. For example, the value
+ 0755 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>includeMetadata</name>
<version>1.0.0+</version>
<type>boolean</type>
@@ -944,7 +1290,9 @@
<name>includes</name>
<version>1.1.0+</version>
<description>
- Set of patterns for matching items to be included from an archive as it is unpacked. (Since 2.2)
+ <![CDATA[
+ Set of file and/or directory patterns for matching items to be included from an archive as it is unpacked. (Since 2.2)
+ ]]>
</description>
<association>
<type>String</type>
@@ -955,7 +1303,9 @@
<name>excludes</name>
<version>1.1.0+</version>
<description>
- Set of patterns for matching items to be excluded from an archive as it is unpacked. (Since 2.2)
+ <![CDATA[
+ Set of file and/or directory patterns for matching items to be excluded from an archive as it is unpacked. (Since 2.2)
+ ]]>
</description>
<association>
<type>String</type>
@@ -991,18 +1341,6 @@
</description>
</field>
<field>
- <name>useStrictFiltering</name>
- <version>1.1.2+</version>
- <type>boolean</type>
- <defaultValue>false</defaultValue>
- <description>
- When specified as true, any include/exclude patterns which aren't used to filter an actual
- artifact during assembly creation will cause the build to fail with an error. This is meant
- to highlight obsolete inclusions or exclusions, or else signal that the assembly descriptor
- is incorrectly configured. (Since 2.2)
- </description>
- </field>
- <field>
<name>useDefaultExcludes</name>
<version>1.1.2+</version>
<type>boolean</type>
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt.vm?rev=1001908&r1=1001907&r2=1001908&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt.vm (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt.vm Mon Sep 27 20:59:33 2010
@@ -34,7 +34,7 @@ Including Module Binaries
involves some tricky considerations that are a result of the way Maven
sorts and executes project builds within a multimodule context. Please
read {{{../../faq.html#module-binaries}this FAQ entry}} if you decide to use them.
-
+
* Introduction
It is common practice to create an assembly using the parent POM of a