Author: andham Date: Mon Nov 7 22:04:40 2016 New Revision: 1768595 URL: http://svn.apache.org/viewvc?rev=1768595&view=rev Log: [MASSEMBLY-794] more updates to site docs for 3.0.0 release
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt.vm 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/examples/multimodule/module-binary-inclusion-simple.apt.vm maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt.vm maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt.vm URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt.vm?rev=1768595&r1=1768594&r2=1768595&view=diff ============================================================================== --- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt.vm (original) +++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/advanced-descriptor-topics.apt.vm Mon Nov 7 22:04:40 2016 @@ -205,8 +205,6 @@ Advanced Assembly-Descriptor Topics * 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 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. 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=1768595&r1=1768594&r2=1768595&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 Mon Nov 7 22:04:40 2016 @@ -37,7 +37,7 @@ Advanced Module-Set Topics * Including and Excluding Modules using a ModuleSet - As you are no doubt aware, Maven 2.0 introduces advanced handling of + As you are no doubt aware, Maven introduces advanced handling of multimodule builds. These are builds which contain multiple, often interrelated projects. In these builds, project hierarchy is established through use of the <<<modules>>> section of the POM, where parent POMs specify 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=1768595&r1=1768594&r2=1768595&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 Mon Nov 7 22:04:40 2016 @@ -30,9 +30,8 @@ Pre-defined Descriptor Files - As of version 2.2, there are four predefined descriptor formats available - for reuse, packaged within the Assembly Plugin, instead of the original three. - Their descriptorIds are: + There are four predefined descriptor formats available for reuse, packaged + within the Assembly Plugin. Their descriptorIds are: %{toc|fromDepth=2|toDepth=2} @@ -81,8 +80,6 @@ Pre-defined Descriptor Files * project - (Since 2.2) - Using the <<<project>>> <<<\<descriptorRef\>>>> in your Assembly Plugin configuration will produce an assembly containing your entire project, minus any build output that lands in the <<</target>>> directory. The resulting 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=1768595&r1=1768594&r2=1768595&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 Nov 7 22:04:40 2016 @@ -35,7 +35,7 @@ Including Module Binaries sorts and executes project builds within a multimodule context. Please read {{{../../faq.html#module-binaries}this FAQ entry}} if you decide to use them. - <<NOTE:>> The new (since 2.2) <<<useAllReactorProjects>>> flag in the <<<moduleSet>>> section + <<NOTE:>> The new <<<useAllReactorProjects>>> flag in the <<<moduleSet>>> section allows you to consume module binaries from child modules in a multimodule build. This is an important to resolve the conflict between Maven's build ordering and the old approach to module binaries, where the assembly was build from the parent POM. Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt.vm URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt.vm?rev=1768595&r1=1768594&r2=1768595&view=diff ============================================================================== --- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt.vm (original) +++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt.vm Mon Nov 7 22:04:40 2016 @@ -41,12 +41,6 @@ Usage styles. For the sake of clarity, we'll cover configuration before execution. -* Deprecation notice - - All goals except <<<assembly:single>>> have been <<deprecated>>. See the - {{{./index.html}introduction page}} for more details. - - * Configuration Getting started with the Assembly Plugin is pretty simple. If you want to use @@ -60,7 +54,7 @@ Usage to customize the suite of binaries your project produces. When the assembly is created it will use the assemblyId as the artifact's classifier and will attach the created assembly to the project so that it will be uploaded into the repository - on the install and deploy goals. + in the install and deploy phase. For example, imagine that our project produces a JAR. If we want to create an assembly binary that includes our project's dependencies, we can take 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=1768595&r1=1768594&r2=1768595&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 Mon Nov 7 22:04:40 2016 @@ -25,12 +25,6 @@ under the License. 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="getting-started"> - <question>There seem to be a large number of mojos available in the assembly plugin. Which goal should I use to build my assembly?</question> - <answer> - <p>You should use the <code>single</code> mojo. All mojos except for <code>single</code> have been deprecated.</p> - </answer> - </faq> <faq id="deploy"> <question>If the Assembly Plugin is run during the package phase, do my assemblies get deployed during the deploy phase?</question> <answer> @@ -74,24 +68,11 @@ under the License. some code was introduced in version 2.2-beta-2 that allowed this parameter to reference descriptors on the classpath, instead of being forced to use <code><descriptorRefs/></code> as is the intention of the design. In version 2.2, this bug was fixed. </p> - <p>It is important to note that the correct form, <code><descriptorRefs/<</code> has always worked, and continues to work. The documentation + <p>It is important to note that the correct form, <code><descriptorRefs/></code> has always worked, and continues to work. The documentation has now been fixed to reflect the correct configuration. </p> </answer> </faq> - <faq id="binding"> - <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> goal.</p> - <p><b>NOTE:</b> All other mojos have been deprecated, either because they can cause strange and unpredictable behavior in a variety of situations, or - because they are redundant given the availability of the <code>dir</code> assembly format and the <code>maven-dependency-plugin</code>. - </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 - 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> - </answer> - </faq> <faq id="module-binaries"> <question>The Assembly Plugin is saying it cannot find files for the module binaries included by my assembly descriptor. What gives?</question> <answer>