Author: hboutemy
Date: Sun Jan 18 20:10:34 2015
New Revision: 1652846
URL: http://svn.apache.org/r1652846
Log:
[MCHECKSTYLE-280] added documentation on upgrading Checkstyle at runtime
Added:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/upgrading-checkstyle.apt.vm
(with props)
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm
maven/plugins/trunk/maven-checkstyle-plugin/src/site/site.xml
Added:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/upgrading-checkstyle.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/upgrading-checkstyle.apt.vm?rev=1652846&view=auto
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/upgrading-checkstyle.apt.vm
(added)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/upgrading-checkstyle.apt.vm
Sun Jan 18 20:10:34 2015
@@ -0,0 +1,59 @@
+ ------
+ Upgrading Checkstyle at Runtime
+ ------
+ 2015-01-18
+ ------
+
+~~ 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
+
+
+Upgrading Checkstyle at Runtime
+
+ Maven Checkstyle plugin comes with a default Checkstyle version: for
<<<maven-checkstyle-plugin ${project.version}>>>,
+ Checkstyle ${checkstyleVersion} is used by default.
+
+ Given Checkstyle generally keeps good compatibility between versions, you
can override the version used at runtime to
+ benefit from
{{{http://checkstyle.sourceforge.net/releasenotes.html}Checkstyle latest
bugfixes}}:
+
++-----+
+<project>
+ ...
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <version>${project.version}</version>
+ <dependencies>
+ <dependency>
+ <groupId>com.puppycrawl.tools</groupId>
+ <artifactId>checkstyle</artifactId>
+ <version>...choose your version...</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ <build>
+ ...
+</project>
++-----+
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/upgrading-checkstyle.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/upgrading-checkstyle.apt.vm
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm?rev=1652846&r1=1652845&r2=1652846&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm
(original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm Sun
Jan 18 20:10:34 2015
@@ -31,7 +31,9 @@ ${project.name}
The Checkstyle Plugin generates a report regarding the code style used by
the developers. For more information about Checkstyle,
see
{{{http://checkstyle.sourceforge.net/}http://checkstyle.sourceforge.net/}}.
- This version of the plugin uses Checkstyle ${checkstyleVersion} and requires
Java ${javaVersion}.
+
+ This version of the plugin uses Checkstyle ${checkstyleVersion} by default
and requires Java ${javaVersion}. But you can
+ {{{./examples/upgrading-checkstyle.html}upgrade the version used at
runtime}}.
The plugin can be configured in the project's POM. Predefined rulesets are
included with the plugin, these are:
{{{./config/sun_checks.html}<<<sun_checks.xml>>>}},
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/site.xml?rev=1652846&r1=1652845&r2=1652846&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/site.xml Sun Jan 18
20:10:34 2015
@@ -31,6 +31,7 @@ under the License.
<item name="Download" href="download.html"/>
</menu>
<menu name="Examples">
+ <item name="Upgrading Checkstyle at Runtime"
href="/examples/upgrading-checkstyle.html"/>
<item name="Using an Inline Checkstyle Checker Configuration"
href="/examples/inline-checker-config.html"/>
<item name="Using a Custom Checkstyle Checker Configuration"
href="/examples/custom-checker-config.html"/>
<item name="Using Custom Checkstyle Property Expansion Definitions"
href="/examples/custom-property-expansion.html"/>
