Author: dennisl
Date: Thu Jan 22 21:13:36 2015
New Revision: 1654076
URL: http://svn.apache.org/r1654076
Log:
[MSHARED-407] Move maven_checks.xml and maven-header.txt to here from
maven-checkstyle-plugin
Added:
maven/shared/trunk/maven-shared-resources/src/main/resources/config/
maven/shared/trunk/maven-shared-resources/src/main/resources/config/maven-header.txt
- copied unchanged from r1654032,
maven/plugins/trunk/maven-checkstyle-plugin/src/main/resources/config/maven-header.txt
maven/shared/trunk/maven-shared-resources/src/main/resources/config/maven_checks.xml
- copied unchanged from r1654032,
maven/plugins/trunk/maven-checkstyle-plugin/src/main/resources/config/maven_checks.xml
maven/shared/trunk/maven-shared-resources/src/site/apt/maven_checks.apt.vm
- copied, changed from r1654032,
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm
Modified:
maven/shared/trunk/maven-shared-resources/pom.xml
maven/shared/trunk/maven-shared-resources/src/site/apt/index.apt.vm
maven/shared/trunk/maven-shared-resources/src/site/apt/usage.apt.vm
Modified: maven/shared/trunk/maven-shared-resources/pom.xml
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-resources/pom.xml?rev=1654076&r1=1654075&r2=1654076&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-resources/pom.xml (original)
+++ maven/shared/trunk/maven-shared-resources/pom.xml Thu Jan 22 21:13:36 2015
@@ -56,4 +56,22 @@
<url>https://builds.apache.org/hudson/job/maven-shared/</url>
</ciManagement>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.rat</groupId>
+ <artifactId>apache-rat-plugin</artifactId>
+ <configuration>
+ <excludes combine.children="append">
+ <!--
+ This is a license header template.
+ -->
+ <exclude>src/main/resources/config/maven-header.txt</exclude>
+ </excludes>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
</project>
Modified: maven/shared/trunk/maven-shared-resources/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-resources/src/site/apt/index.apt.vm?rev=1654076&r1=1654075&r2=1654076&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-resources/src/site/apt/index.apt.vm
(original)
+++ maven/shared/trunk/maven-shared-resources/src/site/apt/index.apt.vm Thu Jan
22 21:13:36 2015
@@ -3,7 +3,7 @@
------
Dennis Lundberg
------
- 2013-07-24
+ 2015-01-22
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -35,14 +35,14 @@ ${project.name}
* Maven Changes Plugin
-** org/apache/maven/plugins/announcement.vm
+** <<<org/apache/maven/plugins/announcement.vm>>>
This is a template that can be used by Maven Changes Plugin to create and
send
an announcement e-mail for one of our plugins. It will create an announcement
e-mail that conforms to the "Promote the release" section of our
{{{http://maven.apache.org/developers/release/maven-project-release-procedure.html#Promote_the_release}release
procedure}}.
-** org/apache/maven/shared/announcement.vm
+** <<<org/apache/maven/shared/announcement.vm>>>
This is a template that can be used by Maven Changes Plugin to create and
send
an announcement e-mail for one of our shared components. It will create an
@@ -50,6 +50,20 @@ ${project.name}
{{{http://maven.apache.org/developers/release/maven-project-release-procedure.html#Promote_the_release}release
procedure}}.
+* Maven Checkstyle Plugin
+
+** <<<config/maven-header.txt>>>
+
+ This is a license header template that can be used by Maven Checkstyle Plugin
+ to verify that all files are using this license header.
+
+** {{{./maven_checks.html}<<<config/maven_checks.xml>>>}}
+
+ This is a Checkstyle configuration file for
+ {{{/developers/conventions/code.html}Maven coding conventions}} that can be
+ used in Maven Checkstyle Plugin.
+
+
* Usage
General instructions on how to use the Maven Shared Resources can be found on
Copied:
maven/shared/trunk/maven-shared-resources/src/site/apt/maven_checks.apt.vm
(from r1654032,
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm)
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-resources/src/site/apt/maven_checks.apt.vm?p2=maven/shared/trunk/maven-shared-resources/src/site/apt/maven_checks.apt.vm&p1=maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm&r1=1654032&r2=1654076&rev=1654076&view=diff
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm
(original)
+++ maven/shared/trunk/maven-shared-resources/src/site/apt/maven_checks.apt.vm
Thu Jan 22 21:13:36 2015
@@ -1,5 +1,5 @@
------
- config/maven_checks.xml Predefined Ruleset
+ config/maven_checks.xml
------
Hervé Boutemy
------
@@ -27,9 +27,10 @@
~~ http://maven.apache.org/doxia/references/apt-format.html
-<<<config/maven_checks.xml>>> Predefined Ruleset
+<<<config/maven_checks.xml>>>
- Maven Checkstyle plugin contains <<<config/maven_checks.xml>>> predefined
ruleset for
- {{{/developers/conventions/code.html}Maven coding conventions}}:
+ This is a predefined ruleset for
+ {{{/developers/conventions/code.html}Maven coding conventions}} that can be
+ used in Maven Checkstyle Plugin:
%{snippet|file=${project.basedir}/src/main/resources/config/maven_checks.xml}
Modified: maven/shared/trunk/maven-shared-resources/src/site/apt/usage.apt.vm
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-resources/src/site/apt/usage.apt.vm?rev=1654076&r1=1654075&r2=1654076&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-resources/src/site/apt/usage.apt.vm
(original)
+++ maven/shared/trunk/maven-shared-resources/src/site/apt/usage.apt.vm Thu Jan
22 21:13:36 2015
@@ -97,6 +97,34 @@ Usage
</project>
+----------+
+ or like this:
+
++----------+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.14</version>
+ <configuration>
+ <configLocation>config/maven_checks.xml</configLocation>
+ <headerLocation>config/maven-header.txt</headerLocation>
+ </configuration>
+ <dependencies>
+ ...
+ </dependencies>
+ <executions>
+ ...
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
++----------+
+
* Execute the plugin
