Author: dennisl
Date: Mon Jul 6 06:17:47 2015
New Revision: 1689315
URL: http://svn.apache.org/r1689315
Log:
[MCHECKSTYLE-285] Remove config/maven_checks.xml by removing the dependency on
maven-shared-resources:2
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/pom.xml
maven/plugins/trunk/maven-checkstyle-plugin/src/it/multi-modules-aggregate/pom.xml
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt.vm
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm
maven/plugins/trunk/maven-checkstyle-plugin/src/test/plugin-configs/custom-plugin-config.xml
Modified: maven/plugins/trunk/maven-checkstyle-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/pom.xml?rev=1689315&r1=1689314&r2=1689315&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/pom.xml Mon Jul 6 06:17:47 2015
@@ -129,11 +129,6 @@ under the License.
<artifactId>maven-reporting-impl</artifactId>
<version>2.3</version>
</dependency>
- <dependency>
- <groupId>org.apache.maven.shared</groupId>
- <artifactId>maven-shared-resources</artifactId>
- <version>2</version>
- </dependency>
<!-- doxia -->
<dependency>
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/it/multi-modules-aggregate/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/it/multi-modules-aggregate/pom.xml?rev=1689315&r1=1689314&r2=1689315&view=diff
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/it/multi-modules-aggregate/pom.xml
(original)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/it/multi-modules-aggregate/pom.xml
Mon Jul 6 06:17:47 2015
@@ -51,6 +51,13 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>@pom.version@</version>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.maven.shared</groupId>
+ <artifactId>maven-shared-resources</artifactId>
+ <version>2</version>
+ </dependency>
+ </dependencies>
</plugin>
</plugins>
</build>
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java?rev=1689315&r1=1689314&r2=1689315&view=diff
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java
(original)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java
Mon Jul 6 06:17:47 2015
@@ -102,12 +102,11 @@ public abstract class AbstractCheckstyle
* </p>
* <p/>
* <p>
- * There are 3 predefined rulesets included in Maven Checkstyle Plugin:
+ * There are 2 predefined rulesets included in Maven Checkstyle Plugin:
* </p>
* <ul>
* <li><code>sun_checks.xml</code>: Sun Checks.</li>
* <li><code>google_checks.xml</code>: Google Checks.</li>
- * <li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
* </ul>
*/
@Parameter( property = "checkstyle.config.location", defaultValue =
"sun_checks.xml" )
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java?rev=1689315&r1=1689314&r2=1689315&view=diff
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
(original)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
Mon Jul 6 06:17:47 2015
@@ -59,7 +59,6 @@ public class CheckstyleReport
Map<String, String> fmt2Cfg = new HashMap<>();
fmt2Cfg.put( "sun", "sun_checks.xml" );
- fmt2Cfg.put( "maven", "config/maven_checks.xml" );
FORMAT_TO_CONFIG_LOCATION = Collections.unmodifiableMap( fmt2Cfg );
}
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java?rev=1689315&r1=1689314&r2=1689315&view=diff
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java
(original)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java
Mon Jul 6 06:17:47 2015
@@ -198,12 +198,11 @@ public class CheckstyleViolationCheckMoj
* </p>
* <p/>
* <p>
- * There are 3 predefined rulesets.
+ * There are 2 predefined rulesets.
* </p>
* <ul>
* <li><code>sun_checks.xml</code>: Sun Checks.</li>
* <li><code>google_checks.xml</code>: Google Checks.</li>
- * <li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
* </ul>
*
* @since 2.5
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt?rev=1689315&r1=1689314&r2=1689315&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
(original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
Mon Jul 6 06:17:47 2015
@@ -2,8 +2,9 @@
Predefined Rulesets
------
Hervé Boutemy
+ Dennis Lundberg
------
- 2015-05-01
+ 2015-07-06
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -29,36 +30,22 @@
Predefined Rulesets
- Maven Checkstyle Plugin no longer contains any predefined rulesets. Instead
it
- references rulesets from other places:
-
- * {{{http://checkstyle.sourceforge.net/sun_style.html}<<<sun_checks.xml>>>}}
-
- *
{{{http://checkstyle.sourceforge.net/google_style.html}<<<google_checks.xml>>>}}
-
- *
{{{/shared/maven-shared-resources/maven_checks.html}<<<config/maven_checks.xml>>>}}
-
- []
-
- In versions up to and including 2.13 the plugin included the
- <<<config/maven_checks.xml>>> predefined ruleset. In version 2.14 this was
- moved to {{{/shared/maven-shared-resources/}maven-shared-resources}}. It is
- still available to use, because maven-shared-resources has been added as a
- dependency to Maven Checkstyle Plugin
-
- In versions up to and including 2.13 the plugin included the
- <<<config/avalon_checks.xml>>> predefined ruleset. This was removed in
- version 2.14.
-
- In versions up to and including 2.14 the plugin included the
- <<<config/turbine_checks.xml>>> predefined ruleset. This was removed in
- version 2.15.
-
- In versions up to and including 2.15 the plugin included the
- <<<config/sun_checks.xml>>> predefined ruleset. This was removed in
- version 2.16 and the plugin instead references the original configuration
- provided by the Checkstyle project.
-
- In versions 2.16 and later the plugin references the <<<google_checks.xml>>>
- predefined ruleset. This is a configuration provided by the Checkstyle
- project.
+ Maven Checkstyle Plugin has had different sets of predefined rulesets across
+ different versions. Some have been included in the plugin itself while others
+ have been references to other projects. The table below shows this history.
+
+*---------------------------------+------------+-----------------------------------------------------------------+-----------------------------------------------------------------+--------+
+| <<Predefined ruleset>> | 2.0 - 2.13 | 2.14
| 2.15
| 2.16 - |
+*---------------------------------+------------+-----------------------------------------------------------------+-----------------------------------------------------------------+--------+
+| <<<config/avalon_checks.xml>>> | Included | -
| -
| - |
+*---------------------------------+------------+-----------------------------------------------------------------+-----------------------------------------------------------------+--------+
+| <<<config/maven_checks.xml>>> | Included |
{{{/shared/maven-shared-resources/maven_checks.html}Reference}} |
{{{/shared/maven-shared-resources/maven_checks.html}Reference}} | - |
+*---------------------------------+------------+-----------------------------------------------------------------+-----------------------------------------------------------------+--------+
+| <<<config/sun_checks.xml>>> | Included | Included
| Included
| - |
+*---------------------------------+------------+-----------------------------------------------------------------+-----------------------------------------------------------------+--------+
+| <<<config/turbine_checks.xml>>> | Included | Included
| -
| - |
+*---------------------------------+------------+-----------------------------------------------------------------+-----------------------------------------------------------------+--------+
+| <<<google_checks.xml>>> | - | -
| -
|
{{{http://checkstyle.sourceforge.net/google_style.html}Reference}} |
+*---------------------------------+------------+-----------------------------------------------------------------+-----------------------------------------------------------------+--------+
+| <<<sun_checks.xml>>> | - | -
| -
|
{{{http://checkstyle.sourceforge.net/sun_style.html}Reference}} |
+*---------------------------------+------------+-----------------------------------------------------------------+-----------------------------------------------------------------+--------+
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt.vm?rev=1689315&r1=1689314&r2=1689315&view=diff
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt.vm
(original)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt.vm
Mon Jul 6 06:17:47 2015
@@ -55,11 +55,9 @@ Using a Custom Checkstyle Checker Config
resource named <<<checkstyle.xml>>> within the compile scope of the
dependencies or build extensions
classpath.
- There are 3 predefined Checkstyle configuration definitions that ship with
the Checkstyle Plugin,
+ There are 2 predefined Checkstyle configuration definitions that ship with
the Checkstyle Plugin,
the Sun Microsystems Definition is selected by default.
* <<sun_checks.xml>> - Sun Microsystems Definition (default).
* <<google_checks.xml>> - Google Definition.
-
- * <<config/maven_checks.xml>> - Maven Development Definitions.
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=1689315&r1=1689314&r2=1689315&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 Mon
Jul 6 06:17:47 2015
@@ -35,11 +35,10 @@ ${project.name}
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:
- {{{http://checkstyle.sourceforge.net/sun_style.html}<<<sun_checks.xml>>>}},
-
{{{http://checkstyle.sourceforge.net/google_style.html}<<<google_checks.xml>>>}}
and
-
{{{/shared/maven-shared-resources/maven_checks.html}<<<config/maven_checks.xml>>>}}.
You can also use a custom ruleset by
- specifying it in the plugin configuration.
+ The plugin can be configured in the project's POM. Predefined rulesets
available for use in this version of the plugin are:
+ {{{http://checkstyle.sourceforge.net/sun_style.html}<<<sun_checks.xml>>>}}
and
+
{{{http://checkstyle.sourceforge.net/google_style.html}<<<google_checks.xml>>>}}.
+ You can also use a custom ruleset by specifying it in the plugin
configuration.
* Goals Overview
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/test/plugin-configs/custom-plugin-config.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/test/plugin-configs/custom-plugin-config.xml?rev=1689315&r1=1689314&r2=1689315&view=diff
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/test/plugin-configs/custom-plugin-config.xml
(original)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/test/plugin-configs/custom-plugin-config.xml
Mon Jul 6 06:17:47 2015
@@ -29,7 +29,7 @@ under the License.
<enableFilesSummary>true</enableFilesSummary>
<enableRSS>true</enableRSS>
<includes>**/*.java</includes>
- <configLocation>config/maven_checks.xml</configLocation>
+ <configLocation>google_checks.xml</configLocation>
<headerLocation>LICENSE.txt</headerLocation>
<headerFile>${basedir}/src/test/test-sources/LICENSE.txt</headerFile>
<cacheFile>${basedir}/target/test-harness/checkstyle/custom/checkstyle-cachefile</cacheFile>
