svn commit: r1753082 - in /maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples: multimodule/module-source-inclusion-simple.apt.vm single/filtering-some-distribution-files.apt.vm single/using-repositories.apt.vm

[gb...@apache.org]

Author: gboue
Date: Sun Jul 17 15:11:06 2016
New Revision: 1753082

URL: http://svn.apache.org/viewvc?rev=1753082&view=rev
Log:
[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.

Modified:
    maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt.vm
    maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt.vm
    maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt.vm

Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt.vm?rev=1753082&r1=1753081&r2=1753082&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt.vm (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt.vm Sun Jul 17 15:11:06 2016
@@ -54,11 +54,20 @@ Including Module Sources
   <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 @@ Including Module Sources
   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 @@ Including Module Sources
   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

Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt.vm?rev=1753082&r1=1753081&r2=1753082&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt.vm (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt.vm Sun Jul 17 15:11:06 2016
@@ -182,5 +182,5 @@ variable2=value2
   To generate the distribution assembly, we then use:
 
 +-----
-mvn assembly:assembly
+mvn clean assembly:single
 +-----

Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt.vm?rev=1753082&r1=1753081&r2=1753082&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt.vm (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt.vm Sun Jul 17 15:11:06 2016
@@ -95,7 +95,7 @@ Using Repositories
   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