You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by bi...@apache.org on 2011/07/04 01:55:40 UTC
svn commit: r1142526 -
/maven/plugins/trunk/maven-shade-plugin/src/site/apt/examples/resource-transformers.apt.vm
Author: bimargulies
Date: Sun Jul 3 23:55:40 2011
New Revision: 1142526
URL: http://svn.apache.org/viewvc?rev=1142526&view=rev
Log:
[MSHADE-102] [DOCS] Added Basic Usage For ApacheNoticeResourceTransformer
Submitted by: Robert Burrell Donkin
Modified:
maven/plugins/trunk/maven-shade-plugin/src/site/apt/examples/resource-transformers.apt.vm
Modified: maven/plugins/trunk/maven-shade-plugin/src/site/apt/examples/resource-transformers.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-shade-plugin/src/site/apt/examples/resource-transformers.apt.vm?rev=1142526&r1=1142525&r2=1142526&view=diff
==============================================================================
--- maven/plugins/trunk/maven-shade-plugin/src/site/apt/examples/resource-transformers.apt.vm (original)
+++ maven/plugins/trunk/maven-shade-plugin/src/site/apt/examples/resource-transformers.apt.vm Sun Jul 3 23:55:40 2011
@@ -33,7 +33,7 @@ Resource Transformers
*-----------------------------------------+--------------------------------------+
| {{ApacheLicenseResourceTransformer}} | Prevents license duplication |
*-----------------------------------------+--------------------------------------+
-| ApacheNoticeResourceTransformer | Prepares merged NOTICE |
+| {{ApacheNoticeResourceTransformer}} | Prepares merged NOTICE |
*-----------------------------------------+--------------------------------------+
| {{AppendingTransformer}} | Adds content to a resource |
*-----------------------------------------+--------------------------------------+
@@ -380,3 +380,43 @@ Transformers in <<<org.apache.maven.plug
...
</project>
+-----
+
+** Aggregating Notices with the {ApacheNoticeResourceTransformer}
+
+ Some licenses
+ (including the {{{http://www.apache.org/licenses/LICENSE-2.0.html} Apache License, Version 2}})
+ require that notices are preserved by downstream distributors. <<<ApacheNoticeResourceTransformer>>>
+ automates the assembly of an appropriate <<<NOTICE>>>.
+
+ For example, to simply merge in dependent notices:
+
++-----
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-shade-plugin</artifactId>
+ <version>${project.version}</version>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <goals>
+ <goal>shade</goal>
+ </goals>
+ <configuration>
+ <transformers>
+ <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer">
+ <addHeader>false</addHeader>
+ </transformer>
+ </transformers>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
++-----