[MASSEMBLY-823] Documentation refers to deprecated goals
Documentation is updated to only to refer to the "single" goal. This requires the example code for the "Include Module Sources" to be adapted, mainly by adding the "useAllReactorProjects" parameter and fixing a deprecation warning about fileSet inclusions.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk@1753082 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt.vm b/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt.vm
index 5867cfa..adf03cf 100644
--- a/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt.vm
+++ b/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt.vm
@@ -54,11 +54,20 @@
<includeBaseDirectory>false</includeBaseDirectory>
<moduleSets>
<moduleSet>
+ <useAllReactorProjects>true</useAllReactorProjects>
<includes>
<include>org.test:child1</include>
</includes>
<sources>
- <outputDirectory>sources/${artifactId}</outputDirectory>
+ <includeModuleDirectory>false</includeModuleDirectory>
+ <fileSets>
+ <fileSet>
+ <outputDirectory>sources/${module.artifactId}</outputDirectory>
+ <excludes>
+ <exclude>${project.build.directory}/**</exclude>
+ </excludes>
+ </fileSet>
+ </fileSets>
</sources>
</moduleSet>
</moduleSets>
@@ -75,11 +84,18 @@
sources should be contained within the directory structure
<<<sources/child1>>> for this module, since the outputDirectory expression
will be interpolated on a module-by-module basis.
+
+ By default, the Assembly Plugin will add the sources under a folder named with the artifactId
+ of each module; this can be disabled by setting <<<includeModuleDirectory>>> to <<<false>>>.
+
+ Note that the build directory (<<<target>>> by default) will be included, so it is explicitly excluded
+ since this is a temporary storage for files produced during the build and it should not contain any
+ project sources.
* The POM
Now, let's review the POM configuration necessary to enable the building of
- this assembly via the <assembly:directory> goal:
+ this assembly via the <assembly:single> goal:
+---+
<?xml version="1.0" encoding="UTF-8"?>
@@ -125,7 +141,7 @@
To build the assembly, we issue the following command:
+---+
-mvn clean assembly:directory
+mvn clean assembly:single
+---+
This will ensure that the output directory (normally, <<<target>>>), is
diff --git a/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt.vm b/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt.vm
index 9fcabce..31023b4 100644
--- a/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt.vm
+++ b/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt.vm
@@ -182,5 +182,5 @@
To generate the distribution assembly, we then use:
+-----
-mvn assembly:assembly
+mvn clean assembly:single
+-----
diff --git a/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt.vm b/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt.vm
index bdc6609..09240b9 100644
--- a/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt.vm
+++ b/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt.vm
@@ -95,7 +95,7 @@
The assembly archive is then created using:
+-----
-mvn assembly:assembly
+mvn clean assembly:single
+-----
The generated archive can be extracted to an internal repository so users of
