Author: jdcasey
Date: Mon Sep 27 20:59:57 2010
New Revision: 1001910
URL: http://svn.apache.org/viewvc?rev=1001910&view=rev
Log:
[MASSEMBLY-455] Bring documentation of built-in descriptors into sync with the
descriptors themselves by using APT snippets.
Added:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt.vm
(with props)
Removed:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/bin.xml
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/jar-with-dependencies.xml
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/project.xml
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/src.xml
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/bin.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/bin.xml?rev=1001910&r1=1001909&r2=1001910&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/bin.xml
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/bin.xml
Mon Sep 27 20:59:57 2010
@@ -18,6 +18,7 @@
under the License.
-->
+<!-- START SNIPPET: bin -->
<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";>
@@ -50,3 +51,4 @@
</fileSet>
</fileSets>
</assembly>
+<!-- END SNIPPET: bin -->
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/jar-with-dependencies.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/jar-with-dependencies.xml?rev=1001910&r1=1001909&r2=1001910&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/jar-with-dependencies.xml
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/jar-with-dependencies.xml
Mon Sep 27 20:59:57 2010
@@ -18,6 +18,7 @@
under the License.
-->
+<!-- START SNIPPET: jar-with-dependencies -->
<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";>
@@ -36,3 +37,4 @@
</dependencySet>
</dependencySets>
</assembly>
+<!-- END SNIPPET: jar-with-dependencies -->
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/project.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/project.xml?rev=1001910&r1=1001909&r2=1001910&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/project.xml
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/project.xml
Mon Sep 27 20:59:57 2010
@@ -18,6 +18,7 @@
under the License.
-->
+<!-- START SNIPPET: project -->
<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";>
@@ -39,3 +40,4 @@
</fileSet>
</fileSets>
</assembly>
+<!-- END SNIPPET: project -->
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/src.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/src.xml?rev=1001910&r1=1001909&r2=1001910&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/src.xml
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/main/resources/assemblies/src.xml
Mon Sep 27 20:59:57 2010
@@ -17,7 +17,7 @@
specific language governing permissions and limitations
under the License.
-->
-
+<!-- START SNIPPET: src -->
<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";>
@@ -45,3 +45,4 @@
</fileSet>
</fileSets>
</assembly>
+<!-- END SNIPPET: src -->
Added:
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=1001910&view=auto
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt.vm
(added)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt.vm
Mon Sep 27 20:59:57 2010
@@ -0,0 +1,103 @@
+ ------
+ Predefined Assembly Descriptors
+ ------
+ Johnny R. Ruiz III <jr...@exist.com>
+ Edwin Punzalan
+ John Casey
+ ------
+ 2 November 2006
+ ------
+
+~~ 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
+~~
+~~ 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
+ for reuse, packaged within the Assembly Plugin, instead of the original
three.
+ Their descriptorIds are:
+
+ * {{{#bin}bin}} - can be used for general assembly of binary packages.
+
+ * {{{#jar-with-dependencies}jar-with-dependencies}} - can be used for general
+ assembly of a binary package with all the dependency libraries included
+ unpacked inside the archive.
+
+ * {{{#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
+ 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>>>
+ in three archive formats: tar.gz, tar.bz2, and zip.
+
+ The assembled archive contains the binary jar produced by running
+ <<<mvn package>>> plus any README, LICENSE, and NOTICE files available in the
+ project root directory.
+
+ Below is the <<<bin>>> descriptor format:
+
+%{snippet|id=bin|url=${project.scm.url}/src/main/resources/assemblies/bin.xml}
+
+* {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.
+ 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:
+
+%{snippet|id=jar-with-dependencies|url=${project.scm.url}/src/main/resources/assemblies/jar-with-dependencies.xml}
+
+* {src}
+
+ 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
+ classifier <<<src>>> in three formats: tar.gz, tar.bz2, and zip.
+
+ Below is the <<<src>>> descriptor format:
+
+%{snippet|id=src|url=${project.scm.url}/src/main/resources/assemblies/src.xml}
+
+* {project}
+
+ 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
+ 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
+ three archive formats: tar.gz, tar.bz2, and zip.
+
+ The following is the assembly descriptor for the <<<project>>> descriptorRef:
+
+%{snippet|id=project|url=${project.scm.url}/src/main/resources/assemblies/project.xml}
Propchange:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
