You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2009/08/05 14:40:02 UTC
svn commit: r801184 - in
/maven/plugins/trunk/maven-assembly-plugin/src/site: ./ apt/ apt/examples/
apt/examples/multimodule/ apt/examples/single/ fml/
Author: vsiveton
Date: Wed Aug 5 12:40:02 2009
New Revision: 801184
URL: http://svn.apache.org/viewvc?rev=801184&view=rev
Log:
o fixed ambiguous links
o added Doxia xsd
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt Wed Aug 5 12:40:02 2009
@@ -4,25 +4,28 @@
John Casey
---
1 December 2006
+ ---
-~~ Copyright 2006 The Apache Software Foundation.
-~~
-~~ Licensed under the Apache License, Version 2.0 (the "License");
-~~ you may not use this file except in compliance with the License.
-~~ You may obtain a copy of the License at
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
+~~ http://www.apache.org/licenses/LICENSE-2.0
~~
-~~ Unless required by applicable law or agreed to in writing, software
-~~ distributed under the License is distributed on an "AS IS" BASIS,
-~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-~~ See the License for the specific language governing permissions and
-~~ limitations under the License.
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-
Advanced Assembly-Descriptor Topics
* Quick Note on All <<<includes>>> and <<<excludes>>> Patterns
@@ -103,59 +106,59 @@
</files>
---
-
+
* Advanced Artifact-Matching in <<<includes>>> and <<<excludes>>>
When using <<<dependencySet>>> or <<<moduleSet>>>, the <<<\<includes/\>>>> and
<<<\<excludes/\>>>> sections actually apply to artifacts, not filenames.
This can be a good thing, since you don't have to know the artifact's
- filename in the local repository. However, explicitly specifying the full
- artifact ID (consisting of groupId, artifactId, version, type, and classifier)
+ filename in the local repository. However, explicitly specifying the full
+ artifact ID (consisting of groupId, artifactId, version, type, and classifier)
for each artifact to be included or excluded can lead to very a verbose
- descriptor. Starting with version 2.2, the assembly plugin addresses the
- clumsiness of explicit artifact identification through the use of wildcard
- patterns.
-
+ descriptor. Starting with version 2.2, the assembly plugin addresses the
+ clumsiness of explicit artifact identification through the use of wildcard
+ patterns.
+
The following easy rules should be applied when specifying artifact-matching
patterns:
-
+
[[1]] Artifacts are matched by a set of identifier strings. In the following
- strings, <<<type>>> is <<<'jar'>>> by default, and <<<classifier>>> is
+ strings, <<<type>>> is <<<'jar'>>> by default, and <<<classifier>>> is
omitted if null.
-
+
* <<<groupId:artifactId:type:classifier>>>
( <<<artifact.getDependencyConflictId()>>> )
-
- * <<<groupId:artifactId>>>
+
+ * <<<groupId:artifactId>>>
( <<<ArtifactUtils.versionlessKey( artifact )>>> )
-
+
* <<<groupId:artifactId:version:type:classifier>>>
( <<<artifact.getId()>>> )
-
+
[]
-
+
[[2]] Any <<<'*'>>> character in an include/exclude pattern will result in the
pattern being split, and the sub-patterns being matched within the three
artifact identifiers mentioned above, using <<<String.indexOf(..)>>>.
-
+
[[3]] When no <<<'*'>>> is present in an include/exclude pattern, the pattern
will only match if the <<entire>> pattern equals one of the three
artifact identifiers above, using the <<<String.equals(..)>>> method.
-
+
[[4]] In case you missed it above, artifact-identification fields are
separated by colons (<<<':'>>>) in the matching strings. So, a wildcard
pattern that matches any artifact of type <<<'war'>>> might be specified
as <<<*:war>>>.
-
+
[]
-
+
** Example: Include all dependencies of type <<<'war'>>>
In this example, we'll configure a <<<dependencySet>>> so it only includes
those <<<war>>> dependencies.
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -174,10 +177,10 @@
In the above example, any <<<war>>> artifacts that happen to have a classifier
(not sure why this particular case would happen, but it <is> possible) will be
- <<skipped>>. If you <really> want to be careful about catching all of the
+ <<skipped>>. If you <really> want to be careful about catching all of the
<<<war>>> artifacts in your project, you might want to use the following
pattern:
-
+
---
*:war:*
---
@@ -188,9 +191,9 @@
often distributed using jar files, in addition to normal binaries. We want to
filter out any source-jar files (they'll be marked with a <<<sources>>>
classifier) from the binary jars.
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -215,27 +218,27 @@
metadata can increase the size of the resulting assembly vastly. By default,
the assembly plugin will exclude metadata files for most common source-control
systems from the <<<fileSet>>>s specified in the descriptor.
-
+
On the other hand, what if you <wanted> to include Subversion metadata
- directories? Starting with version 2.2, the assembly plugin offers the
- <<<useDefaultExcludes>>> option on all <<<fileSet>>> elements, in order to
+ directories? Starting with version 2.2, the assembly plugin offers the
+ <<<useDefaultExcludes>>> option on all <<<fileSet>>> elements, in order to
accommodate this use case.
-
+
** Example: Bundle project sources for a developer-quickstart pack
In this example, let's examine what happens if you have a large project in
source control. This project contains a large number of sizable files that
- haven't changed since the day they were added, in the early stages of the
+ haven't changed since the day they were added, in the early stages of the
project's lifetime. You want to enable potential developers to get started
quickly, without checking out hundreds of 10-megabyte files first.
-
+
The compression incorporated with many archiving formats can offer an
advantage here. If we create a project assembly, including Subversion metadata
directories, developers should be able to download the assembly artifact and
expand it, then simply type <<<svn up>>>.
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -252,33 +255,33 @@
---
<NOTE: You'll notice that we're excluding all target directories; these are a
- form of "calculated" and otherwise transient data, and generally shouldn't be
+ form of "calculated" and otherwise transient data, and generally shouldn't be
included in archives, unless your goal is to create project binaries or
similar.>
-
+
* Using Regular Expressions to Exclude Files
<<Since: 2.2-beta-4>>
- Sometimes, you may find you need to specify an extremely fine-grained inclusion or
+ Sometimes, you may find you need to specify an extremely fine-grained inclusion or
exclusion pattern for a <<<fileSet>>>. In these cases, you have the option of specifying
your pattern in the form of a regular expression by using the <<<%regex[...]>>> syntax.
-
+
<Note:> For completeness, the default pattern type - Ant-style patterns - can also be
specified using the new <<<%ant[...]>>> syntax. This will allow room for future expansion
of <<<fileSet>>> patterns, including the option to change the default pattern syntax
someday.
-
+
** Example: Including directories named <<<target>>> in the <<<src>>> directory
- In this example, we want to produce a buildable source distribution of a
+ In this example, we want to produce a buildable source distribution of a
Maven project hierarchy. Obviously, each project's <<<target>>> directory is
a temporary workspace for the build process, so we want to exclude these
directories. However, if one or more of the projects also includes a subdirectory
named <<<target>>> in the <<<src>>> directory structure - perhaps as part of
a Java package name - we want to make sure the files in this directory are
included in the assembly.
-
+
---
<assembly>
[...]
@@ -296,36 +299,36 @@
</assembly>
---
- The above <<<fileSet>>> uses a somewhat obscure feature of regular
+ The above <<<fileSet>>> uses a somewhat obscure feature of regular
expressions called <negative lookahead>, which means our exclude pattern
- will only match paths that contain the word <<<target>>> but <<don't>>
+ will only match paths that contain the word <<<target>>> but <<don't>>
contain <<<src>>>. Effectively, any <<<target>>> directory within the
<<<src>>> directory structure will be preserved in the assembly.
-
+
* Using Strict-Filtering to Catch Obsolete Patterns or Incorrect Builds
At times, you want to build in a set of sanity checks when creating your
assembly, to ensure that what goes into the assembly artifact is what you
intended. One way you can do this is by enabling <<<useStrictFiltering>>> on
your <<<dependencySets>>>, <<<moduleSets>>>, and <<<fileSets>>>.
-
+
<<<useStrictFiltering>>> is a flag that tells the assembly plugin to track
each include/exclude pattern to make sure it's used during creation of the
- assembly. This way, if the assembly-descriptor author intended for a particular
- file or artifact to be present, he can add an include/exclude pattern to the
- descriptor to ensure that file/artifact is present, and then set the
- <<<useStrictFiltering>>> flag. If the pattern isn't used to match at least one
- file during assembly creation, the build will fail and the user will receive a
+ assembly. This way, if the assembly-descriptor author intended for a particular
+ file or artifact to be present, he can add an include/exclude pattern to the
+ descriptor to ensure that file/artifact is present, and then set the
+ <<<useStrictFiltering>>> flag. If the pattern isn't used to match at least one
+ file during assembly creation, the build will fail and the user will receive a
message notifying him of the unused patterns.
-
+
** Example: Ensuring the LICENSE.txt file is included in a jar
In this example, we want to make sure that our project jar contains the
project's open source license language, in order to be compliant with our
software foundation's policies.
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -345,7 +348,7 @@
If a developer inadvertently removes the LICENSE.txt from the project
directory, the assembly plugin should refuse to build this assembly.
-
+
* Using an Alternative Assembly Base Directory
In many cases, assemblies should have all files arranged under one assembly
@@ -353,15 +356,15 @@
contents collected in a nice, neat directory structure, rather than spread
throughout the current working directory. This is achieved using the
<<<includeBaseDirectory>>> flag, and this flag is set to <<<true>>> by
- default, which will result in the project's <<<artifactId-version>>> being
+ default, which will result in the project's <<<artifactId-version>>> being
used as the assembly base directory.
-
+
However, in some special cases you may want to use a different directory name
for the root of your assembly. Starting in the 2.2 version of the assembly
plugin, this use case is addressed using the <<<baseDirectory>>> element of
- the assembly descriptor. With this element, you can use POM expressions and
+ the assembly descriptor. With this element, you can use POM expressions and
static strings to specify the name of the assembly root directory.
-
+
** Example: Eclipse-style invariable directory name for the Maven assembly
In this example, let's explore what would happen if we wanted Maven to use the
@@ -371,9 +374,9 @@
consider that the distribution assembly is currently built from the
<<<maven-core>>> project, which means we shouldn't use the <<<artifactId>>> as
part of the assembly root directory.
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -385,9 +388,9 @@
Now, imagine that the distribution assembly were created in the top-level
<<<maven>>> project. Now, we <can> use the <<<artifactId>>>, and probably
should, just to minimize the maintenance of these files.
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -401,7 +404,7 @@
One of the most complex sections of the assembly descriptor is the
<<<moduleSets>>> section. In fact, so many improvements have been made to this
section that we feel it warrants its own <"Advanced Topics"> page.
-
- * Go to {{{advanced-module-set-topics.html}Advanced Module-Set Topics}}.
-
+
+ * Go to {{{./advanced-module-set-topics.html}Advanced Module-Set Topics}}.
+
[]
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt Wed Aug 5 12:40:02 2009
@@ -6,31 +6,33 @@
1 December 2006
---
-~~ Copyright 2006 The Apache Software Foundation.
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
~~
-~~ Licensed under the Apache License, Version 2.0 (the "License");
-~~ you may not use this file except in compliance with the License.
-~~ You may obtain a copy of the License at
+~~ http://www.apache.org/licenses/LICENSE-2.0
~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing, software
-~~ distributed under the License is distributed on an "AS IS" BASIS,
-~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-~~ See the License for the specific language governing permissions and
-~~ limitations under the License.
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-
Advanced Module-Set Topics
* Quick Note
Some of the topics in this document refer to more general topics or
improvements in the assembly descriptor as a whole. For more information, see
- the {{{advanced-descriptor-topics.html}Advanced Assembly-Descriptor Topics}}
+ the {{{./advanced-descriptor-topics.html}Advanced Assembly-Descriptor Topics}}
page.
* Including and Excluding Modules using a ModuleSet
@@ -42,7 +44,7 @@
their children in a <<<modules>>> section. Other relationships, like
interdependency, also exist within multimodule builds; however, these are
beyond the scope of this document.
-
+
When constructing an assembly from any parent-level project in a multimodule
build, it's possible to process this parent-POM's descendent modules, and
include them in some form within the resulting assembly artifact. By default,
@@ -50,18 +52,18 @@
inclusion or exclusion. Also, include/exclude patterns for modules are matched
using the artifact-matching rules explained in the <<Advanced
Assembly-Descriptor Topics>> document.
-
+
The following examples describe how to select certain modules in the project
hierarchy using basic artifact includes/excludes. It does <<not>> describe
what to do with the selected modules; to learn about the actions available for
selected modules, see {{including module sources}} and {{including module
binaries}} below. For other, more advanced module-handling options, read on!
-
+
** Example: Select one from a set of child projects
Given the following project structure, and all appropriate module references
in the parent POM:
-
+
---
+ parent (groupId: org.test, artifactId: parent)
|
@@ -71,9 +73,9 @@
---
We can select <<just>> the child1 module using the following <<<moduleSet>>>:
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -92,7 +94,7 @@
<NOTE: It's important to remember that, if the child1 project itself had
children, those children would not be included just because the child1 project
was included. Each module is matched separately.>
-
+
~~ [jdcasey] TODO: Amend this once we've handled the case where you want to process
~~ the entire inheritance/dependency trail. We'll need a flag to say "Include
~~ my ancestry when matching for includes/excludes", and have that apply
@@ -104,11 +106,11 @@
When used from within a <<<moduleSet>>>, all <<<outputFileNameMapping>>>
configurations with expressions like <<<$\{artifactId\}>>> <extract information
from the artifact in question.>
-
+
** Example: Setting <<<outputFileNameMapping>>> from <<<moduleSet/binaries>>>
Given a module with the following:
-
+
---
Group Id: org.test
Artifact Id: project
@@ -117,14 +119,14 @@
---
The following <<<outputFileNameMapping>>>:
-
+
---
${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
---
Will result in a file called <<<org.test-project-1.0.jar>>> being created
within the assembly.
-
+
<NOTE: The expression <<<$\{module.extension\}>>> is mapped to the file extension
supplied by the ArtifactHandler for the type <<<jar>>>. It's important to
remember that the file extension <<need not be .jar>>.>
@@ -133,14 +135,14 @@
Once you've selected certain modules to be included in the assembly, you have
to determine what you want included from each module. This usually depends on
- the purpose of the assembly. For instance, if you're building a binary
+ the purpose of the assembly. For instance, if you're building a binary
assembly, for use in a runtime context, you probably want to include module
binaries only (see the {{Including Module Binaries}} section below). However,
if your assembly is meant to include project sources, either as a reference or
to allow users to build your project (or for some other reason altogether),
then you're probably interested in the <<<sources>>> section of the
<<<moduleSet>>>.
-
+
Processing module sources is a fileSet-based activity. That is, sources are
included or excluded based on file-matching patterns, or explicit
<<<fileSet>>> subsections. <<For backward compatibility only>>, the
@@ -149,7 +151,7 @@
processed. Starting in version 2.2 of the assembly plugin, the
<<<\<sources/\>>>> section supports a <<<\<fileSets/\>>>> subsection, which is
the preferred way of selecting module-source files for processing.
-
+
** Example: including the <<<src>>> directory from each selected module
In this example, we'll explore how to include the <<<src>>> directory <<only>>
@@ -157,7 +159,7 @@
reference for your project to users.
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -183,9 +185,9 @@
directory, for each selected module, within your assembly. This is useful to
give your users the chance to tinker with your project, then build it on their
own.
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -210,26 +212,26 @@
<NOTE: We exclude the target directory, since this is assumed to be temporary
storage for files produced during the course of a Maven build. Permanent
project files are not meant to reside here...>
-
+
** Consolidating All Module Sources into a Single Directory Structure
Normally, each module processed by the assembly plugin is placed within its
own directory structure inside the assembly root directory. For module
sources, the default name of this module-specific directory is the module's
<<<artifactId>>>.
-
+
However, in some cases you may want to consolidate module sources into the
same directory structure, based in the assembly root directory. To do this,
simply set the <<<includeModuleDirectory>>> flag to <<<false>>>.
-
+
*** Example: Copy all module sources into a single <<<src>>> directory
- When providing a source reference to users, you may want to produce a single,
- consolidated source directory containing all of the source files from your
+ When providing a source reference to users, you may want to produce a single,
+ consolidated source directory containing all of the source files from your
multimodule hierarchy.
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -263,19 +265,19 @@
within the project hierarchy - through a flat module-processing mechanism.
Processing only the first level of modules is the default configuration for
the <<<sources>>> section of a <<<moduleSet>>>.
-
- To explicitly process modules of modules - sub-modules, that is - simply use
+
+ To explicitly process modules of modules - sub-modules, that is - simply use
the <<<excludeSubModuleDirectories>>> flag, set to <<<false>>>.
-
+
*** Example: Providing a shallow source-directory structure for reference
- Consider the case where you want to preserve the context of all source files
+ Consider the case where you want to preserve the context of all source files
within your project hierarchy, according to the project in which they belong.
At the same time, you want to avoid confusing users with a complex nesting of
projects within projects, and present a simple list of projects to browse.
-
+
If your project hierarchy looks like this:
-
+
---
+ application
|
@@ -303,7 +305,7 @@
---
You may want it to look like this in the resulting assembly:
-
+
---
+ application
| |
@@ -334,7 +336,7 @@
<<<excludeSubModuleDirectories>>> flag, as follows:
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -362,20 +364,20 @@
*WARNING!* Using the <<<binaries>>> section of a <<<moduleSet>>> definition
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.
+ read {{{./faq.html#module-binaries}this FAQ entry}} if you decide to use them.
In cases where your assembly artifact is meant to be used in a runtime
- context, you'll most likely want to include the binaries from any modules
+ context, you'll most likely want to include the binaries from any modules
processed by the assembly plugin. This can be as simple as adding the module's
jar artifact to your assembly archive; or, it can involve selectively
including the dependencies of that module in addition to the module's own jar.
-
+
At any rate, processing module binaries is an artifact-based activity.
Accordingly, selection of the appropriate artifacts for a given module follows
- the artifact inclusion rules explained in the <<Advanced Assembly-Descriptor
+ the artifact inclusion rules explained in the <<Advanced Assembly-Descriptor
Topics>> document.
-
- Once you've selected <which> artifacts should be processed for a particular
+
+ Once you've selected <which> artifacts should be processed for a particular
module, you have several options for <how> to process them. In its simplest
form, the <<<binaries>>> section of a <<<moduleSet>>> has many of the same
characteristics as a <<<dependencySet>>>. That is, you have the option to
@@ -387,11 +389,11 @@
Sometimes it's important to have the option to add artifacts from a module
that are not the main project artifact. Such artifacts might include javadocs,
project sources, or even other assembly artifacts.
-
+
*** Example: Including other assemblies within the current assembly
Suppose we have the following project structure:
-
+
---
+ application
|
@@ -403,20 +405,20 @@
---
Further, suppose that the assembly plugin is currently executing at the
- <<<application>>> level, but that another assembly archive has been created
+ <<<application>>> level, but that another assembly archive has been created
previously for the <<<app-site>>> project. This other assembly archive is a
zip file containing the project website. We want to include a copy of this
website in the application distribution assembly, which we are creating now.
-
+
Finally, suppose that the website-attachment has a classifier of <<<site>>>
taken from the assemblyId.
-
+
Since the zipfile containing the website produced by <<<app-site>>> is an
attached artifact in that module, we'll need to extract that artifact instead
of the main project artifact.
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -442,19 +444,19 @@
they will simply fail to execute. By default, module dependencies are included
when the module itself is included. However, as we saw in the above example,
there are times when this may not be appropriate.
-
+
In the above example, the module binary included was an assembly artifact that
contained the website for the application. Other assemblies might embody a
completely self-contained version of the module's binaries, with all
dependency classes unpacked and inlined within the archive.
-
+
In short, sometimes we want to turn off automatic dependency inclusion. We can
achieve this by setting the <<<includeDependencies>>> flag to <<<false>>>.
-
+
*** Example: Including a <<<jar-with-dependencies>>> module assembly
Suppose we have the following project structure:
-
+
---
+ application
|
@@ -464,14 +466,14 @@
---
Further, suppose that the assembly plugin is currently executing at the
- <<<app-web>>> level, but that another assembly archive has been created
- previously for the <<<app-db>>> project using the built-in
+ <<<app-web>>> level, but that another assembly archive has been created
+ previously for the <<<app-db>>> project using the built-in
<<<jar-with-dependencies>>> assembly descriptor. This assembly archive
contains all of the module dependencies, so it's not necessary to include this
module's dependencies in the current assembly.
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
[...]
@@ -491,7 +493,7 @@
</assembly>
---
- <NOTE: The <<<binaries>>> section still accommodates direct <<<\<includes/\>>>>
- and <<<\<excludes/\>>>> subsections, for specifying which module-dependencies
+ <NOTE: The <<<binaries>>> section still accommodates direct <<<\<includes/\>>>>
+ and <<<\<excludes/\>>>> subsections, for specifying which module-dependencies
to include in the assembly. However, these are deprecated, and only provided
for backward compatibility.>
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt Wed Aug 5 12:40:02 2009
@@ -1,33 +1,36 @@
------
- Predefined Assembly Descriptors
+ Predefined Assembly Descriptors
------
Johnny R. Ruiz III <jr...@exist.com>
Edwin Punzalan
John Casey
------
2 November 2006
+ ------
-~~ Copyright 2006 The Apache Software Foundation.
-~~
-~~ Licensed under the Apache License, Version 2.0 (the "License");
-~~ you may not use this file except in compliance with the License.
-~~ You may obtain a copy of the License at
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
+~~ http://www.apache.org/licenses/LICENSE-2.0
~~
-~~ Unless required by applicable law or agreed to in writing, software
-~~ distributed under the License is distributed on an "AS IS" BASIS,
-~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-~~ See the License for the specific language governing permissions and
-~~ limitations under the License.
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-
Pre-defined Descriptor Files
- As of version 2.2, there are now four predefined descriptor formats available
+ As of version 2.2, there are now four predefined descriptor formats available
for reuse, packaged within the Assembly Plugin, instead of the original three.
Their descriptorIds are:
@@ -39,18 +42,18 @@
* {{{#src}src}} - can be used for general assembly of a source archive which can
be used to build your project.
-
+
* {{{#project}project}} - <<new in version 2.2>>, this is used to create an
assembly of the entire source project, including the Maven POM and other files
- outside of your source directory structure, but excluding all SCM files and
+ outside of your source directory structure, but excluding all SCM files and
the target directory. <<GOTCHA:>> If you use an output directory other than
/target, this descriptorRef may include the output from your build process.
* {bin}
- Use <<<bin>>> as the <<<descriptorRef>>> of your assembly-plugin configuration
- in order to create a binary distribution archive of your project.
- This built-in descriptor produces an assembly with the classifier <<<bin>>>
+ Use <<<bin>>> as the <<<descriptorRef>>> of your assembly-plugin configuration
+ in order to create a binary distribution archive of your project.
+ This built-in descriptor produces an assembly with the classifier <<<bin>>>
in three archive formats: tar.gz, tar.bz2, and zip.
The assembled archive contains the binary jar produced by running
@@ -60,7 +63,7 @@
Below is the <<<bin>>> descriptor format:
-----
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<id>bin</id>
@@ -90,15 +93,15 @@
* {jar-with-dependencies}
Use <<<jar-with-dependencies>>> as the <<<descriptorRef>>> of your
- assembly-plugin configuration in order to create a jar archive which contains
- the binary output of your project, along its the unpacked dependencies.
+ assembly-plugin configuration in order to create a jar archive which contains
+ the binary output of your project, along its the unpacked dependencies.
This built-in descriptor produces an assembly with the classifier
<<<jar-with-dependencies>>> using the jar archive format.
Below is the <<<jar-with-dependencies>>> descriptor format:
-----
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<id>jar-with-dependencies</id>
@@ -125,13 +128,13 @@
Use <<<src>>> as the <<<descriptorRef>>> in your assembly-plugin configuration
to create source archives for your project. The archive will contain the
contents of your project's <<</src>>> directory structure, for referency by
- your users. The <<<src>>> descriptorId produces an assembly archive with the
+ your users. The <<<src>>> descriptorId produces an assembly archive with the
classifier <<<src>>> in three formats: tar.gz, tar.bz2, and zip.
Below is the <<<src>>> descriptor format:
-----
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<id>src</id>
@@ -165,13 +168,13 @@
any build output that lands in the <<</target>>> directory. The resulting
assembly should allow your users to build your project using Maven, Ant, or
whatever build system you have configured in your project's normal SCM working
- directory. It produces assemblies with the classifier <<<project>>> in
+ directory. It produces assemblies with the classifier <<<project>>> in
three archive formats: tar.gz, tar.bz2, and zip.
-
+
The following is the assembly descriptor for the <<<project>>> descriptorRef:
-
+
---
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<id>project</id>
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt Wed Aug 5 12:40:02 2009
@@ -33,26 +33,26 @@
Below, you will see a series of examples showing how to use the Assembly
Plugin in various contexts.
- * {{{single/index.html}Working with Single Projects}}
+ * {{{./single/index.html}Working with Single Projects}}
- * {{{single/filtering-some-distribution-files.html}Filtering Some Distribution Files}}
+ * {{{./single/filtering-some-distribution-files.html}Filtering Some Distribution Files}}
- * {{{single/including-and-excluding-artifacts.html}Including/Excluding Artifacts}}
+ * {{{./single/including-and-excluding-artifacts.html}Including/Excluding Artifacts}}
- * {{{single/using-components.html}Using Component Descriptors}}
+ * {{{./single/using-components.html}Using Component Descriptors}}
- * {{{single/using-repositories.html}Using Repositories}}
+ * {{{./single/using-repositories.html}Using Repositories}}
[]
- * {{{multimodule/index.html}Working with Multi-Module Projects}}
+ * {{{./multimodule/index.html}Working with Multi-Module Projects}}
- * {{{multimodule/module-source-inclusion-simple.html}Adding Module Sources to the Assembly}}
+ * {{{./multimodule/module-source-inclusion-simple.html}Adding Module Sources to the Assembly}}
- * {{{multimodule/module-binary-inclusion-simple.html}Adding Module Binaries to the Assembly}}
+ * {{{./multimodule/module-binary-inclusion-simple.html}Adding Module Binaries to the Assembly}}
[]
- * {{{sharing-descriptors.html}Sharing Assembly Descriptors}}
+ * {{{./sharing-descriptors.html}Sharing Assembly Descriptors}}
[]
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt Wed Aug 5 12:40:02 2009
@@ -6,19 +6,23 @@
24-July-2006
---
-~~ Copyright 2006 The Apache Software Foundation.
-~~
-~~ Licensed under the Apache License, Version 2.0 (the "License");
-~~ you may not use this file except in compliance with the License.
-~~ You may obtain a copy of the License at
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
+~~ http://www.apache.org/licenses/LICENSE-2.0
~~
-~~ Unless required by applicable law or agreed to in writing, software
-~~ distributed under the License is distributed on an "AS IS" BASIS,
-~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-~~ See the License for the specific language governing permissions and
-~~ limitations under the License.
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
@@ -30,6 +34,8 @@
The examples below may be able to help you when creating assemblies for your
multimodule project.
- * {{{module-source-inclusion-simple.html}Adding Module Sources to the Assembly}}
+ * {{{./module-source-inclusion-simple.html}Adding Module Sources to the Assembly}}
+
+ * {{{./module-binary-inclusion-simple.html}Adding Module Binaries to the Assembly}}
- * {{{module-binary-inclusion-simple.html}Adding Module Binaries to the Assembly}}
+ []
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt Wed Aug 5 12:40:02 2009
@@ -6,19 +6,22 @@
24-July-2006
---
-~~ Copyright 2006 The Apache Software Foundation.
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
~~
-~~ Licensed under the Apache License, Version 2.0 (the "License");
-~~ you may not use this file except in compliance with the License.
-~~ You may obtain a copy of the License at
+~~ http://www.apache.org/licenses/LICENSE-2.0
~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing, software
-~~ distributed under the License is distributed on an "AS IS" BASIS,
-~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-~~ See the License for the specific language governing permissions and
-~~ limitations under the License.
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
@@ -30,10 +33,10 @@
The examples below may help you in creating assemblies for your single
projects.
- * {{{filtering-some-distribution-files.html}Filtering Some Distribution Files}}
+ * {{{./filtering-some-distribution-files.html}Filtering Some Distribution Files}}
- * {{{including-and-excluding-artifacts.html}Including/Excluding Artifacts}}
+ * {{{./including-and-excluding-artifacts.html}Including/Excluding Artifacts}}
- * {{{using-components.html}Using Component Descriptors}}
+ * {{{./using-components.html}Using Component Descriptors}}
- * {{{using-repositories.html}Using Repositories}}
+ * {{{./using-repositories.html}Using Repositories}}
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt Wed Aug 5 12:40:02 2009
@@ -4,61 +4,65 @@
John Casey
---
12-May-2006
+ ---
-~~ Copyright 2006 The Apache Software Foundation.
-~~
-~~ Licensed under the Apache License, Version 2.0 (the "License");
-~~ you may not use this file except in compliance with the License.
-~~ You may obtain a copy of the License at
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
+~~ http://www.apache.org/licenses/LICENSE-2.0
~~
-~~ Unless required by applicable law or agreed to in writing, software
-~~ distributed under the License is distributed on an "AS IS" BASIS,
-~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-~~ See the License for the specific language governing permissions and
-~~ limitations under the License.
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Features
- The current version of this plugin can be found {{{project-summary.html}here}}.
+ The current version of this plugin can be found {{{./project-summary.html}here}}.
<NOTE: Features with no version information have been present since the first final release of the plugin.>
* Inclusion of dependencies, modules <[2.1]>, file-sets, and individual files
-
+
* Inclusion of project website documentation <[2.1]>
-
+
* Flexible directory structures for assembly elements
-
+
* All assembly inclusions controlled by include/exclude pattern sets
* Option to unpack artifact files into the assembly <[deprecated in 2.2]>
* Project modules can be included as source files or in binary form <[2.1]>
-
+
* Reusable assembly-descriptor components <[2.1]>
-
+
* Supported archive formats include: zip, tar, tar.gz, tar.bz2, jar, dir, war
(and any other format that the ArchiveManager has been configured for).
-
+
* Directory-only assemblies
-
+
* Filtering and line-ending conversion for file-sets and individual files
-
+
* Directory and file attributes (<modes>) <[2.1]>
-
+
* Artifact filename mapping with expression support <[2.1]>
-
+
* Descriptor interpolation using current project and other assembly descriptor information <[2.1]>
-
+
* Embedded Maven repository creation with artifact version alignment <[2.1]>
-
+
* Security / signature information stripped from embedded artifacts prior to inclusion <[2.1]>
-
+
[]
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt Wed Aug 5 12:40:02 2009
@@ -5,31 +5,34 @@
Edwin Punzalan
---
2 November 2006
+ ---
-~~ Copyright 2006 The Apache Software Foundation.
-~~
-~~ Licensed under the Apache License, Version 2.0 (the "License");
-~~ you may not use this file except in compliance with the License.
-~~ You may obtain a copy of the License at
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
+~~ http://www.apache.org/licenses/LICENSE-2.0
~~
-~~ Unless required by applicable law or agreed to in writing, software
-~~ distributed under the License is distributed on an "AS IS" BASIS,
-~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-~~ See the License for the specific language governing permissions and
-~~ limitations under the License.
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-
Maven Assembly Plugin
~~ * Status
-~~
+~~
~~ <<Current Assembly Plugin Version is: 2.1>>
-~~
+~~
* Introduction
Do you want to create a binary distribution from a Maven project that includes
@@ -39,9 +42,9 @@
This plugin generates "assemblies". It is the equivalent of the Maven 1
distribution plug-in. This plugin provides the capability to create binary
and source distributions. These distributions (assemblies) are defined using
- an assembly descriptor. You can write your own {{{assembly.html}descriptor}}
+ an assembly descriptor. You can write your own {{{./assembly.html}descriptor}}
to create a custom assembly, or you can reuse one of the three
- {{{descriptor-refs.html}pre-defined assemblies}}.
+ {{{./descriptor-refs.html}pre-defined assemblies}}.
Currently it can create distributions in the following formats:
@@ -68,7 +71,7 @@
* run "mvn assembly:assembly" on your project.
To write your own custom assembly, you will need to refer to the
- {{{assembly.html}Assembly Descriptor Format}} reference.
+ {{{./assembly.html}Assembly Descriptor Format}} reference.
What is an Assembly?
@@ -89,7 +92,7 @@
"bin" directory of an assembly and to change the permissions of the files in
the "bin" directory to UNIX mode 755. The parameters for configuring this
behavior are supplied to the Assembly Plugin by way of the
- {{{assembly.html}assembly descriptor}}.
+ {{{./assembly.html}assembly descriptor}}.
The Maven Assembly Plugin
@@ -108,13 +111,13 @@
* Goals
- For more information about the goals that are available in the Assembly Plugin, see {{{plugin-info.html}the plugin documentation page}}.
+ For more information about the goals that are available in the Assembly Plugin, see {{{./plugin-info.html}the plugin documentation page}}.
* Assembly Descriptor Schemas (XSD)
* {{{http://maven.apache.org/xsd/assembly-1.1.1.xsd}http://maven.apache.org/xsd/assembly-1.1.1.xsd}} (for version 2.2-beta-4 and higher)
-
+
* {{{http://maven.apache.org/xsd/assembly-1.1.0.xsd}http://maven.apache.org/xsd/assembly-1.1.0.xsd}} (for version 2.2-beta-3 and lower)
* {{{http://maven.apache.org/xsd/assembly-1.0.0.xsd}http://maven.apache.org/xsd/assembly-1.0.0.xsd}} (for versions 2.1 and lower)
@@ -124,26 +127,26 @@
* Usage
- General instructions on how to use the Assembly Plugin can be found on the {{{usage.html}usage page}}. Some more
+ General instructions on how to use the Assembly Plugin can be found on the {{{./usage.html}usage page}}. Some more
specific use cases are described in the examples given below. Last but not least, users occasionally contribute
additional examples, tips or errata to the
{{{http://docs.codehaus.org/display/MAVENUSER/Assembly+Plugin}plugin's wiki page}}.
- In case you still have questions regarding the plugin's usage, please have a look at the {{{faq.html}FAQ}} and feel
- free to contact the {{{mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
+ In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
+ free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
- the {{{mail-lists.html}mail archive}}.
+ the {{{./mail-lists.html}mail archive}}.
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
- {{{issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
+ {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
- {{{source-repository.html}source repository}} and will find supplementary information in the
+ {{{./source-repository.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
* Examples
To provide you with better understanding on some usages of the Assembly
Plugin, you can take a look into the examples which can be found
- {{{examples/index.html}here}}.
+ {{{./examples/index.html}here}}.
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml Wed Aug 5 12:40:02 2009
@@ -19,7 +19,11 @@
under the License.
-->
-<faqs id="FAQ" title="Frequently Asked Questions">
+
+<faqs xmlns="http://maven.apache.org/FML/1.0.1"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"
+ id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="deploy">
<question>If the Assembly Plugin is run during the package phase, do my assemblies get deployed during the deploy phase?</question>
@@ -46,7 +50,7 @@
<question>What goal should I use to create an assembly as part of my normal build process?</question>
<answer>
<p>Use the <a href="single-mojo.html">single</a> or <a href="directory-single-mojo.html">directory-single</a> goal.</p>
- <p>Since the <a href="assembly-mojo.html">assembly</a>, <a href="attached-mojo.html">attached</a>, <a href="directory-mojo.html">directory</a>, and <a href="directory-inline-mojo.html">directory-inline</a> goals are all aggregators, they will execute at most once
+ <p>Since the <a href="assembly-mojo.html">assembly</a>, <a href="attached-mojo.html">attached</a>, <a href="directory-mojo.html">directory</a>, and <a href="directory-inline-mojo.html">directory-inline</a> goals are all aggregators, they will execute at most once
per execution of Maven. See <a href="http://docs.codehaus.org/display/MAVEN/Atypical+Plugin+Use+Cases">Atypical+Plugin+Use+Cases</a> (wiki) for more
information on the problems associated with aggregator mojos.
</p>
@@ -60,17 +64,17 @@
a multimodule project layout.
</p>
<p>In a multimodule hierarchy, when a child module declares the parent POM in its <parent/> section, Maven interprets this to mean that the parent
- project's build must be completed before the child build can start. This ensures that the parent project is in its final form by the time the child
+ project's build must be completed before the child build can start. This ensures that the parent project is in its final form by the time the child
needs access to its POM information. In cases where the Assembly Plugin is included as part of that parent project's build process, it will execute
along with everything else as part of the parent build - <b>before the child build can start</b>. If the assembly descriptor used in that parent build
- references module binaries, it effectively expects the child build to be completed <b>before the assembly is processed</b>. This leads to a recursive
+ references module binaries, it effectively expects the child build to be completed <b>before the assembly is processed</b>. This leads to a recursive
dependency situation, where the child build depends on the parent build to complete before it can start, while the parent build depends on the presence
- of child-module artifacts to complete successfully. Since these artifacts are missing, the Assembly Plugin will complain about missing artifacts, and
+ of child-module artifacts to complete successfully. Since these artifacts are missing, the Assembly Plugin will complain about missing artifacts, and
the build will fail.
</p>
<p>In many cases, you can avoid this problem by adding a new child module whose sole purpose is to produce your assembly. In the POM for this new project,
add dependency definitions for any of the module binaries you had previously referenced. Then, move your assembly descriptor into this new child module,
- and change all module-binary references to dependencySet references. Obviously, any fileSet or file references you may have in this descriptor may need
+ and change all module-binary references to dependencySet references. Obviously, any fileSet or file references you may have in this descriptor may need
to be adjusted or have the files they reference moved into the new child module alongside the descriptor itself.
</p>
<p>In cases where you absolutely must use module-binaries references, you should avoid binding your assembly into the main build lifecycle. Modify your POM
@@ -88,7 +92,7 @@
<part id="Artifact and Directory Formatting">
<faq id="dashClassifier">
<question>
- I have a dependencySet that includes some artifacts with classifiers, and others without classifiers.
+ I have a dependencySet that includes some artifacts with classifiers, and others without classifiers.
How can I setup the file mappings to handle both cases appropriately?
</question>
<answer>
@@ -99,7 +103,7 @@
does, it will substitute the artifact's classifier - prepended by a dash - in place of the expression.
</p>
<p>
- For example, suppose you want to include two artifacts, commons-logging-1.0.4.jar, and
+ For example, suppose you want to include two artifacts, commons-logging-1.0.4.jar, and
yourserver-1.0-client.jar (where 'client' is the classifier of the second artifact). To do this,
simply add the following to your dependencySet:
</p>
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml?rev=801184&r1=801183&r2=801184&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml Wed Aug 5 12:40:02 2009
@@ -19,7 +19,10 @@
under the License.
-->
-<project>
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd"
+ name="Maven Assembly plugin">
<body>
<menu name="Reference">
<item name="Features" href="features.html"/>