Author: baerrach
Date: Tue Sep 16 22:10:41 2008
New Revision: 696152
URL: http://svn.apache.org/viewvc?rev=696152&view=rev
Log:
[MECLIPSE-166] added example documentation for creating checkstyle
configurations to site.
Added:
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/configure-checkstyle.apt
(with props)
Added:
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/configure-checkstyle.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/configure-checkstyle.apt?rev=696152&view=auto
==============================================================================
---
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/configure-checkstyle.apt
(added)
+++
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/configure-checkstyle.apt
Tue Sep 16 22:10:41 2008
@@ -0,0 +1,64 @@
+ ------
+ Configure Checkstyle
+ ------
+ Barrie Treloar
+ ------
+ 17 September 2008
+ ------
+
+Configure Checkstyle
+
+ You can configure checkstyle by creating/importing your Checkstyle Check
Configuration in Eclipse
+ and then in your pom specify:
+
+ * additionalBuildcommands
+
+ * additionalProjectnatures
+
+ * additionalConfig to create the .checkstyle file.
+
+ []
+
+ See the example below, make sure you specify the correct value in
<<<check-config-name>>>.
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-eclipse-plugin</artifactId>
+ <configuration>
+ <additionalBuildcommands>
+
<buildcommand>com.atlassw.tools.eclipse.checkstyle.CheckstyleBuilder</buildcommand>
+ </additionalBuildcommands>
+ <additionalProjectnatures>
+
<projectnature>com.atlassw.tools.eclipse.checkstyle.CheckstyleNature</projectnature>
+ </additionalProjectnatures>
+ <additionalConfig>
+ <file>
+ <name>.checkstyle</name>
+ <content>
+ <![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<fileset-config file-format-version="1.2.0" simple-config="true">
+ <fileset name="all" enabled="true" check-config-name="<YOUR CHECKSTYLE
CONFIG NAME HERE>" local="false">
+ <file-match-pattern match-pattern="." include-pattern="true"/>
+ </fileset>
+ <filter name="NonSrcDirs" enabled="true"/>
+</fileset-config>
+]]>
+ </content>
+ </file>
+ </additionalConfig>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
\ No newline at end of file
Propchange:
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/configure-checkstyle.apt
------------------------------------------------------------------------------
svn:eol-style = native
