Author: baerrach
Date: Thu Apr 19 01:41:36 2012
New Revision: 1327772
URL: http://svn.apache.org/viewvc?rev=1327772&view=rev
Log:
[MCHECKSTYLE-175] Upgrade usage.htm to make it clear how configuration is done
Upgraded usage.apt.vm to have a new section for configuring the plugin with
Maven 3 and Maven 2 notes.
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt.vm
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt.vm?rev=1327772&r1=1327771&r2=1327772&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt.vm
(original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt.vm Thu
Apr 19 01:41:36 2012
@@ -69,9 +69,13 @@ mvn site
mvn checkstyle:checkstyle
+-----+
- To specifically configure the Checkstyle Plugin, you need to the add it in the
- <<<\<build\>>>> section of your <<<pom.xml>>> as
- shown in the sample below.
+* Configure the Checkstyle Plugin
+
+** Maven 3
+
+ As per
{{{https://cwiki.apache.org/MAVEN/maven-3x-compatibility-notes.html}Maven 3
Compatibility Notes}}
+ to configure the Checkstyle Plugin, you need to the add it in the
<<<\<build\>>>> section of your <<<pom.xml>>> as
+ shown in the sample below.
+-----+
<project>
@@ -92,3 +96,8 @@ mvn checkstyle:checkstyle
...
</project>
+-----+
+
+** Maven 2
+
+ You may need to duplicate some configuration details between the
<<<\<build\>>>> section and the <<<\<reporting\>>>>
+ section, depending on whether you use checkstyle as part of the build, part
of site, or both.
\ No newline at end of file
