Author: bimargulies
Date: Thu Jun 30 12:42:49 2011
New Revision: 1141511
URL: http://svn.apache.org/viewvc?rev=1141511&view=rev
Log:
[MASSEMBLY-562]: apply doc patch to refer to shade, while here fix some
warnings having to do with
the current APT format for link anchors.
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt.vm
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt.vm
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt.vm?rev=1141511&r1=1141510&r2=1141511&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt.vm
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-module-set-topics.apt.vm
Thu Jun 30 12:42:49 2011
@@ -56,8 +56,9 @@ Advanced Module-Set Topics
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!
+ selected modules, see {{{Including_Module_Sources}including module sources}}
+ and {{{Including_Module_Binaries}including module binaries}}
+ below. For other, more advanced module-handling options, read on!
** Example: Select one from a set of child projects
@@ -137,7 +138,7 @@ ${module.groupId}-${module.artifactId}-$
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
assembly, for use in a runtime context, you probably want to include module
- binaries only (see the {{Including Module Binaries}} section below). However,
+ 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
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt.vm?rev=1141511&r1=1141510&r2=1141511&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt.vm
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt.vm
Thu Jun 30 12:42:49 2011
@@ -59,6 +59,10 @@ Pre-defined Descriptor Files
This built-in descriptor produces an assembly with the classifier
<<<jar-with-dependencies>>> using the JAR archive format.
+ Note that <<<jar-with-dependencies>>> provides only basic support for
uber-jars.
+ For more control, use the
+ {{{http://maven.apache.org/plugins/maven-shade-plugin/} Maven Shade Plugin}}.
+
Below is the <<<jar-with-dependencies>>> descriptor format:
%{snippet|id=jar-with-dependencies|file=src/main/resources/assemblies/jar-with-dependencies.xml}
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=1141511&r1=1141510&r2=1141511&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 Thu Jun 30
12:42:49 2011
@@ -38,10 +38,11 @@ Maven Assembly Plugin
Your project can build distribution "assemblies" easily, using one of the
convenient, {{{./descriptor-refs.html}prefabricated assembly descriptors}}.
These descriptors handle many common operations, such as packaging a
project's
- artifact along with its dependencies in a single JAR. Alternatively, your
- project can provide its own {{{./assembly.html}descriptor}} and assume a much
- higher level of control over how dependencies, modules, file-sets, and
- individual files are packaged in the assembly.
+ artifact along with generated documentation into a
+ {{{./descriptor-refs.html#bin}single zip archive}}.
+ Alternatively, your project can provide its own
{{{./assembly.html}descriptor}}
+ and assume a much higher level of control over how dependencies, modules,
+ file-sets, and individual files are packaged in the assembly.
Currently it can create distributions in the following formats:
@@ -59,6 +60,10 @@ Maven Assembly Plugin
* and any other format that the ArchiveManager has been configured for
+ If your project wants to package your artifact in an uber-jar, the assembly
+ plugin provides only basic support. For more control, use the
+ {{{http://maven.apache.org/plugins/maven-shade-plugin/} Maven Shade Plugin}}.
+
To use the Assembly Plugin in Maven, you simply need to:
* choose or write the assembly descriptor to use,
@@ -70,7 +75,6 @@ Maven Assembly Plugin
To write your own custom assembly, you will need to refer to the
{{{./assembly.html}Assembly Descriptor Format}} reference.
-
* What is an Assembly?
An "assembly" is a group of files, directories, and dependencies that are
