You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by de...@apache.org on 2015/05/02 12:15:10 UTC
svn commit: r949876 [10/17] - in
/websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST:
./ apidocs/ config/ css/ examples/ images/ testapidocs/ xref-test/ xref/
Modified: websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/examples/multi-module-config.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/examples/multi-module-config.html (original)
+++ websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/examples/multi-module-config.html Sat May 2 10:15:09 2015
@@ -1,302 +1,307 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
- | Generated by Apache Maven Doxia at 2015-04-11
- | Rendered using Apache Maven Stylus Skin 1.5
--->
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <title>Apache Maven Checkstyle Plugin – Multimodule Configuration</title>
- <style type="text/css" media="all">
- @import url("../css/maven-base.css");
- @import url("../css/maven-theme.css");
- @import url("../css/site.css");
- </style>
- <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="2008-02-05" />
- <meta name="Date-Revision-yyyymmdd" content="20150411" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
-<script type="text/javascript">_uacct = "UA-140879-1";
- urchinTracker();</script>
- </head>
- <body class="composite">
- <div id="banner">
- <a href="../../../" id="bannerLeft">
- <img src="../../../images/apache-maven-project-2.png" alt="" />
- </a>
- <span id="bannerRight">
- <img src="../../../images/maven-logo-2.gif" alt="" />
- </span>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="breadcrumbs">
-
- <div class="xleft">
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
- <a href="../../../index.html">Maven</a>
- >
- <a href="../../index.html">Plugins</a>
- >
- <a href="../">Apache Maven Checkstyle Plugin</a>
- >
- Multimodule Configuration
- </div>
- <div class="xright">
- Last Published: 2015-04-11
- | Version: 2.16-SNAPSHOT
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="leftColumn">
- <div id="navcolumn">
-
- <h5>Overview</h5>
- <ul>
- <li class="none">
- <a href="../index.html">Introduction</a>
- </li>
- <li class="none">
- <a href="../plugin-info.html">Goals</a>
- </li>
- <li class="none">
- <a href="../usage.html">Usage</a>
- </li>
- <li class="none">
- <a href="../faq.html">FAQ</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
- </li>
- <li class="none">
- <a href="../download.html">Download</a>
- </li>
- <li class="none">
- <a href="../history.html">Releases History</a>
- </li>
- </ul>
- <h5>Examples</h5>
- <ul>
- <li class="none">
- <a href="../examples/upgrading-checkstyle.html">Upgrading Checkstyle at Runtime</a>
- </li>
- <li class="none">
- <a href="../examples/inline-checker-config.html">Using an Inline Checkstyle Checker Configuration</a>
- </li>
- <li class="none">
- <a href="../examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
- </li>
- <li class="none">
- <a href="../examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a>
- </li>
- <li class="none">
- <a href="../examples/suppressions-filter.html">Using a Suppressions Filter</a>
- </li>
- <li class="none">
- <a href="../examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Checks</a>
- </li>
- <li class="none">
- <strong>Multimodule Configuration</strong>
- </li>
- </ul>
- <h5>Project Documentation</h5>
- <ul>
- <li class="collapsed">
- <a href="../project-info.html">Project Information</a>
- </li>
- <li class="collapsed">
- <a href="../project-reports.html">Project Reports</a>
- </li>
- </ul>
- <h5>Maven Projects</h5>
- <ul>
- <li class="none">
- <a href="../../../ant-tasks/index.html">Ant Tasks</a>
- </li>
- <li class="none">
- <a href="../../../archetype/index.html">Archetype</a>
- </li>
- <li class="none">
- <a href="../../../doxia/index.html">Doxia</a>
- </li>
- <li class="none">
- <a href="../../../jxr/index.html">JXR</a>
- </li>
- <li class="none">
- <a href="../../../ref/current">Maven</a>
- </li>
- <li class="none">
- <a href="../../../pom/index.html">Parent POMs</a>
- </li>
- <li class="none">
- <a href="../../index.html">Plugins</a>
- </li>
- <li class="none">
- <a href="../../../plugin-testing/index.html">Plugin Testing</a>
- </li>
- <li class="none">
- <a href="../../../plugin-tools/index.html">Plugin Tools</a>
- </li>
- <li class="none">
- <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a>
- </li>
- <li class="none">
- <a href="../../../scm/index.html">SCM</a>
- </li>
- <li class="none">
- <a href="../../../shared/index.html">Shared Components</a>
- </li>
- <li class="none">
- <a href="../../../skins/index.html">Skins</a>
- </li>
- <li class="none">
- <a href="../../../surefire/index.html">Surefire</a>
- </li>
- <li class="none">
- <a href="../../../wagon/index.html">Wagon</a>
- </li>
- </ul>
- <h5>ASF</h5>
- <ul>
- <li class="none">
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
- </li>
- </ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
- </a>
-
- </div>
- </div>
- <div id="bodyColumn">
- <div id="contentBox">
- <!-- 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 --><div class="section">
-<h2><a name="Multimodule_Configuration"></a>Multimodule Configuration</h2>
-<p>Configuring the Checkstyle Plugin for use within large multimodule projects can be done, but it requires a little setup.</p>
-<p>This example will use a mysterious project called <i>whizbang</i>. This is what the structure of that project looks like:</p>
-<div class="source">
-<pre>whizbang
-|-- pom.xml
-|-- core
-| `-- pom.xml
-|-- gui
-| `-- pom.xml
-|-- jmx
-| `-- pom.xml
-`-- src</pre></div>
-<div class="section">
-<h3><a name="Create_a_subproject_to_house_the_resources"></a>Create a subproject to house the resources</h3>
-<p>We'll start by adding another sub project that will house our common configuration. Let's call it <i>build-tools</i>. In it we put the resources that we want to include. In this example, we will add configuration files for the Checkstyle Plugin. Configuration files for other plugins, like the PMD plugin, can be included in the same subproject if you like.</p>
-<div class="source">
-<pre>whizbang
-|-- pom.xml
-|-- build-tools
-| |-- src
-| | `-- main
-| | `-- resources
-| | `-- whizbang
-| | |-- checkstyle.xml
-| | `-- LICENSE.TXT
-| `-- pom.xml
-|-- core
-|-- gui
-|-- jmx
-`-- src</pre></div>
-<p><b>Tip:</b> put the resources into a subdirectory that you can ensure will be unique and not conflict with anyone else.</p>
-<p>The <tt>pom.xml</tt> file for <i>build-tools</i> should look like this:</p>
-<div class="source">
-<pre><project>
- <modelVersion>4.0.0</modelVersion>
- <groupId>com.example.whizbang</groupId>
- <artifactId>build-tools</artifactId>
- <version>1.0</version>
- <name>Build Tools</name>
-</project></pre></div></div>
-<div class="section">
-<h3><a name="Configure_the_other_projects_to_use_it"></a>Configure the other projects to use it</h3>
-<p>Now we can include the Checkstyle configuration in the top level <tt>pom.xml</tt>.</p>
-<p><b>Note:</b> You have to specify a plugin dependency on <tt>build-tools</tt> in the <tt><build></tt> element of your <tt>pom.xml</tt>. It will not work inside the <tt><reporting></tt> element, because <tt><reporting></tt> does not support plugin dependencies. The rest of the configuration is done in the normal way in the <tt><reporting></tt> element.</p>
-<div class="source">
-<pre><project>
- <modelVersion>4.0.0</modelVersion>
- <groupId>com.example.whizbang</groupId>
- <artifactId>whizbang-parent</artifactId>
- <version>1.0</version>
- <packaging>pom</packaging>
- <name>WhizBang Parent</name>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.16-SNAPSHOT</version>
- <dependencies>
- <dependency>
- <groupId>com.example.whizbang</groupId>
- <artifactId>build-tools</artifactId>
- <version>1.0</version>
- </dependency>
- </dependencies>
- </plugin>
- </plugins>
- </build>
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.16-SNAPSHOT</version>
- <configuration>
- <configLocation>whizbang/checkstyle.xml</configLocation>
- <headerLocation>whizbang/LICENSE.txt</headerLocation>
- </configuration>
- </plugin>
- </plugins>
- </reporting>
- <modules>
- <module>build-tools</module>
- <module>core</module>
- <module>jmx</module>
- <module>gui</module>
- </modules>
-</project></pre></div>
-<p>Once you are done with that, ensure that you do not include the Maven Checkstyle Plugin in your sub modules, as their definition and configuration, will override the top level parent pom's definition.</p>
-<p>Based on the Checkstyle Plugin configuration above, the values of <tt>configLocation</tt> and <tt>headerLocation</tt> will be resolved from the classpath. The <i>build-tools</i> JAR was included in the classpath when it was declared as a dependency to the plugin.</p>
-<p>Lastly, kick off a build of the site.</p>
-<div class="source">
-<pre>mvn site</pre></div>
-<p>Every sub project will now use the same Checkstyle setup and configuration.</p></div></div>
- </div>
- </div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2005-2015
- The Apache Software Foundation
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
- Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- </body>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at 2015-05-02
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Apache Maven Checkstyle Plugin – Multimodule Configuration</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="2008-02-05" />
+ <meta name="Date-Revision-yyyymmdd" content="20150502" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="../">Apache Maven Checkstyle Plugin</a>
+ >
+ Multimodule Configuration
+ </div>
+ <div class="xright">
+ Last Published: 2015-05-02
+ | Version: 2.16-SNAPSHOT
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="../plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <a href="../usage.html">Usage</a>
+ </li>
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
+ </li>
+ <li class="none">
+ <a href="../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../history.html">Releases History</a>
+ </li>
+ </ul>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="../examples/upgrading-checkstyle.html">Upgrading Checkstyle at Runtime</a>
+ </li>
+ <li class="none">
+ <a href="../examples/inline-checker-config.html">Using an Inline Checkstyle Checker Configuration</a>
+ </li>
+ <li class="none">
+ <a href="../examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
+ </li>
+ <li class="none">
+ <a href="../examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a>
+ </li>
+ <li class="none">
+ <a href="../examples/suppressions-filter.html">Using a Suppressions Filter</a>
+ </li>
+ <li class="none">
+ <a href="../examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Checks</a>
+ </li>
+ <li class="none">
+ <strong>Multimodule Configuration</strong>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../ref/current">Maven</a>
+ </li>
+ <li class="none">
+ <a href="../../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../plugin-testing/index.html">Plugin Testing</a>
+ </li>
+ <li class="none">
+ <a href="../../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- 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 --><div class="section">
+<h2><a name="Multimodule_Configuration"></a>Multimodule Configuration</h2>
+<p>Configuring the Checkstyle Plugin for use within large multimodule projects can be done, but it requires a little setup.</p>
+<p>This example will use a mysterious project called <i>whizbang</i>. This is what the structure of that project looks like:</p>
+<div class="source">
+<pre>whizbang
+|-- pom.xml
+|-- core
+| `-- pom.xml
+|-- gui
+| `-- pom.xml
+|-- jmx
+| `-- pom.xml
+`-- src
+</pre></div>
+<div class="section">
+<h3><a name="Create_a_subproject_to_house_the_resources"></a>Create a subproject to house the resources</h3>
+<p>We'll start by adding another sub project that will house our common configuration. Let's call it <i>build-tools</i>. In it we put the resources that we want to include. In this example, we will add configuration files for the Checkstyle Plugin. Configuration files for other plugins, like the PMD plugin, can be included in the same subproject if you like.</p>
+<div class="source">
+<pre>whizbang
+|-- pom.xml
+|-- build-tools
+| |-- src
+| | `-- main
+| | `-- resources
+| | `-- whizbang
+| | |-- checkstyle.xml
+| | `-- LICENSE.TXT
+| `-- pom.xml
+|-- core
+|-- gui
+|-- jmx
+`-- src
+</pre></div>
+<p><b>Tip:</b> put the resources into a subdirectory that you can ensure will be unique and not conflict with anyone else.</p>
+<p>The <tt>pom.xml</tt> file for <i>build-tools</i> should look like this:</p>
+<div class="source">
+<pre><project>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>com.example.whizbang</groupId>
+ <artifactId>build-tools</artifactId>
+ <version>1.0</version>
+ <name>Build Tools</name>
+</project>
+</pre></div></div>
+<div class="section">
+<h3><a name="Configure_the_other_projects_to_use_it"></a>Configure the other projects to use it</h3>
+<p>Now we can include the Checkstyle configuration in the top level <tt>pom.xml</tt>.</p>
+<p><b>Note:</b> You have to specify a plugin dependency on <tt>build-tools</tt> in the <tt><build></tt> element of your <tt>pom.xml</tt>. It will not work inside the <tt><reporting></tt> element, because <tt><reporting></tt> does not support plugin dependencies. The rest of the configuration is done in the normal way in the <tt><reporting></tt> element.</p>
+<div class="source">
+<pre><project>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>com.example.whizbang</groupId>
+ <artifactId>whizbang-parent</artifactId>
+ <version>1.0</version>
+ <packaging>pom</packaging>
+ <name>WhizBang Parent</name>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.16-SNAPSHOT</version>
+ <dependencies>
+ <dependency>
+ <groupId>com.example.whizbang</groupId>
+ <artifactId>build-tools</artifactId>
+ <version>1.0</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ </plugins>
+ </build>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.16-SNAPSHOT</version>
+ <configuration>
+ <configLocation>whizbang/checkstyle.xml</configLocation>
+ <headerLocation>whizbang/LICENSE.txt</headerLocation>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+ <modules>
+ <module>build-tools</module>
+ <module>core</module>
+ <module>jmx</module>
+ <module>gui</module>
+ </modules>
+</project>
+</pre></div>
+<p>Once you are done with that, ensure that you do not include the Maven Checkstyle Plugin in your sub modules, as their definition and configuration, will override the top level parent pom's definition.</p>
+<p>Based on the Checkstyle Plugin configuration above, the values of <tt>configLocation</tt> and <tt>headerLocation</tt> will be resolved from the classpath. The <i>build-tools</i> JAR was included in the classpath when it was declared as a dependency to the plugin.</p>
+<p>Lastly, kick off a build of the site.</p>
+<div class="source">
+<pre>mvn site
+</pre></div>
+<p>Every sub project will now use the same Checkstyle setup and configuration.</p></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2015
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
</html>
\ No newline at end of file
Modified: websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/examples/suppressions-filter.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/examples/suppressions-filter.html (original)
+++ websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/examples/suppressions-filter.html Sat May 2 10:15:09 2015
@@ -1,245 +1,247 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
- | Generated by Apache Maven Doxia at 2015-04-11
- | Rendered using Apache Maven Stylus Skin 1.5
--->
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <title>Apache Maven Checkstyle Plugin – Using a Suppressions Filter</title>
- <style type="text/css" media="all">
- @import url("../css/maven-base.css");
- @import url("../css/maven-theme.css");
- @import url("../css/site.css");
- </style>
- <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="2006-07-21" />
- <meta name="Date-Revision-yyyymmdd" content="20150411" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
-<script type="text/javascript">_uacct = "UA-140879-1";
- urchinTracker();</script>
- </head>
- <body class="composite">
- <div id="banner">
- <a href="../../../" id="bannerLeft">
- <img src="../../../images/apache-maven-project-2.png" alt="" />
- </a>
- <span id="bannerRight">
- <img src="../../../images/maven-logo-2.gif" alt="" />
- </span>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="breadcrumbs">
-
- <div class="xleft">
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
- <a href="../../../index.html">Maven</a>
- >
- <a href="../../index.html">Plugins</a>
- >
- <a href="../">Apache Maven Checkstyle Plugin</a>
- >
- Using a Suppressions Filter
- </div>
- <div class="xright">
- Last Published: 2015-04-11
- | Version: 2.16-SNAPSHOT
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="leftColumn">
- <div id="navcolumn">
-
- <h5>Overview</h5>
- <ul>
- <li class="none">
- <a href="../index.html">Introduction</a>
- </li>
- <li class="none">
- <a href="../plugin-info.html">Goals</a>
- </li>
- <li class="none">
- <a href="../usage.html">Usage</a>
- </li>
- <li class="none">
- <a href="../faq.html">FAQ</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
- </li>
- <li class="none">
- <a href="../download.html">Download</a>
- </li>
- <li class="none">
- <a href="../history.html">Releases History</a>
- </li>
- </ul>
- <h5>Examples</h5>
- <ul>
- <li class="none">
- <a href="../examples/upgrading-checkstyle.html">Upgrading Checkstyle at Runtime</a>
- </li>
- <li class="none">
- <a href="../examples/inline-checker-config.html">Using an Inline Checkstyle Checker Configuration</a>
- </li>
- <li class="none">
- <a href="../examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
- </li>
- <li class="none">
- <a href="../examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a>
- </li>
- <li class="none">
- <strong>Using a Suppressions Filter</strong>
- </li>
- <li class="none">
- <a href="../examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Checks</a>
- </li>
- <li class="none">
- <a href="../examples/multi-module-config.html">Multimodule Configuration</a>
- </li>
- </ul>
- <h5>Project Documentation</h5>
- <ul>
- <li class="collapsed">
- <a href="../project-info.html">Project Information</a>
- </li>
- <li class="collapsed">
- <a href="../project-reports.html">Project Reports</a>
- </li>
- </ul>
- <h5>Maven Projects</h5>
- <ul>
- <li class="none">
- <a href="../../../ant-tasks/index.html">Ant Tasks</a>
- </li>
- <li class="none">
- <a href="../../../archetype/index.html">Archetype</a>
- </li>
- <li class="none">
- <a href="../../../doxia/index.html">Doxia</a>
- </li>
- <li class="none">
- <a href="../../../jxr/index.html">JXR</a>
- </li>
- <li class="none">
- <a href="../../../ref/current">Maven</a>
- </li>
- <li class="none">
- <a href="../../../pom/index.html">Parent POMs</a>
- </li>
- <li class="none">
- <a href="../../index.html">Plugins</a>
- </li>
- <li class="none">
- <a href="../../../plugin-testing/index.html">Plugin Testing</a>
- </li>
- <li class="none">
- <a href="../../../plugin-tools/index.html">Plugin Tools</a>
- </li>
- <li class="none">
- <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a>
- </li>
- <li class="none">
- <a href="../../../scm/index.html">SCM</a>
- </li>
- <li class="none">
- <a href="../../../shared/index.html">Shared Components</a>
- </li>
- <li class="none">
- <a href="../../../skins/index.html">Skins</a>
- </li>
- <li class="none">
- <a href="../../../surefire/index.html">Surefire</a>
- </li>
- <li class="none">
- <a href="../../../wagon/index.html">Wagon</a>
- </li>
- </ul>
- <h5>ASF</h5>
- <ul>
- <li class="none">
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
- </li>
- </ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
- </a>
-
- </div>
- </div>
- <div id="bodyColumn">
- <div id="contentBox">
- <!-- 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 --><div class="section">
-<h2><a name="Using_a_Suppressions_Filter"></a>Using a Suppressions Filter</h2>
-<p>Checkstyle allows the definition of a list of files and their line ranges that should be suppressed from reporting any violations (known as a <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Filters">suppressions filter</a> ).</p>
-<p>Example: <tt>checkstyle-suppressions.xml</tt></p>
-<div class="source">
-<pre><?xml version="1.0"?>
-
-<!DOCTYPE suppressions PUBLIC
- "-//Puppy Crawl//DTD Suppressions 1.0//EN"
- "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
-
-<suppressions>
- <suppress checks="JavadocStyleCheck"
- files="GeneratedObject.java"
- lines="50-9999"/>
- <suppress checks="MagicNumberCheck"
- files="LegacyDatasetConvertor.java"
- lines="221,250-295"/>
-</suppressions></pre></div>
-<p>Example: <tt>pom.xml</tt> - Specifies the suppressions filter that Checkstyle should use.</p>
-<div class="source">
-<pre><project>
- ...
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.16-SNAPSHOT</version>
- <configuration>
- <configLocation>checkstyle.xml</configLocation>
- <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
- <suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExpression>
- </configuration>
- </plugin>
- </plugins>
- </reporting>
- ...
-</project></pre></div></div>
- </div>
- </div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2005-2015
- The Apache Software Foundation
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
- Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- </body>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at 2015-05-02
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Apache Maven Checkstyle Plugin – Using a Suppressions Filter</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="2006-07-21" />
+ <meta name="Date-Revision-yyyymmdd" content="20150502" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="../">Apache Maven Checkstyle Plugin</a>
+ >
+ Using a Suppressions Filter
+ </div>
+ <div class="xright">
+ Last Published: 2015-05-02
+ | Version: 2.16-SNAPSHOT
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="../plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <a href="../usage.html">Usage</a>
+ </li>
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
+ </li>
+ <li class="none">
+ <a href="../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../history.html">Releases History</a>
+ </li>
+ </ul>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="../examples/upgrading-checkstyle.html">Upgrading Checkstyle at Runtime</a>
+ </li>
+ <li class="none">
+ <a href="../examples/inline-checker-config.html">Using an Inline Checkstyle Checker Configuration</a>
+ </li>
+ <li class="none">
+ <a href="../examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
+ </li>
+ <li class="none">
+ <a href="../examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a>
+ </li>
+ <li class="none">
+ <strong>Using a Suppressions Filter</strong>
+ </li>
+ <li class="none">
+ <a href="../examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Checks</a>
+ </li>
+ <li class="none">
+ <a href="../examples/multi-module-config.html">Multimodule Configuration</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../ref/current">Maven</a>
+ </li>
+ <li class="none">
+ <a href="../../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../plugin-testing/index.html">Plugin Testing</a>
+ </li>
+ <li class="none">
+ <a href="../../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- 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 --><div class="section">
+<h2><a name="Using_a_Suppressions_Filter"></a>Using a Suppressions Filter</h2>
+<p>Checkstyle allows the definition of a list of files and their line ranges that should be suppressed from reporting any violations (known as a <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Filters">suppressions filter</a> ).</p>
+<p>Example: <tt>checkstyle-suppressions.xml</tt></p>
+<div class="source">
+<pre><?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+ "-//Puppy Crawl//DTD Suppressions 1.0//EN"
+ "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
+
+<suppressions>
+ <suppress checks="JavadocStyleCheck"
+ files="GeneratedObject.java"
+ lines="50-9999"/>
+ <suppress checks="MagicNumberCheck"
+ files="LegacyDatasetConvertor.java"
+ lines="221,250-295"/>
+</suppressions>
+</pre></div>
+<p>Example: <tt>pom.xml</tt> - Specifies the suppressions filter that Checkstyle should use.</p>
+<div class="source">
+<pre><project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.16-SNAPSHOT</version>
+ <configuration>
+ <configLocation>checkstyle.xml</configLocation>
+ <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
+ <suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExpression>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
+</pre></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2015
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
</html>
\ No newline at end of file
Modified: websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/examples/upgrading-checkstyle.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/examples/upgrading-checkstyle.html (original)
+++ websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/examples/upgrading-checkstyle.html Sat May 2 10:15:09 2015
@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
- | Generated by Apache Maven Doxia at 2015-04-11
+ | Generated by Apache Maven Doxia at 2015-05-02
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
@@ -13,7 +13,7 @@
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
<meta name="author" content="2015-01-18" />
- <meta name="Date-Revision-yyyymmdd" content="20150411" />
+ <meta name="Date-Revision-yyyymmdd" content="20150502" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
@@ -47,7 +47,7 @@
Upgrading Checkstyle at Runtime
</div>
<div class="xright">
- Last Published: 2015-04-11
+ Last Published: 2015-05-02
| Version: 2.16-SNAPSHOT
</div>
<div class="clear">
@@ -107,10 +107,10 @@
</ul>
<h5>Project Documentation</h5>
<ul>
- <li class="collapsed">
+ <li class="collapsed">
<a href="../project-info.html">Project Information</a>
</li>
- <li class="collapsed">
+ <li class="collapsed">
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
@@ -187,7 +187,7 @@
<div id="contentBox">
<!-- 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 --><div class="section">
<h2><a name="Upgrading_Checkstyle_at_Runtime"></a>Upgrading Checkstyle at Runtime</h2>
-<p>Maven Checkstyle plugin comes with a default Checkstyle version: for <tt>maven-checkstyle-plugin 2.16-SNAPSHOT</tt>, Checkstyle 6.1.1 is used by default.</p>
+<p>Maven Checkstyle plugin comes with a default Checkstyle version: for <tt>maven-checkstyle-plugin 2.16-SNAPSHOT</tt>, Checkstyle 6.2 is used by default.</p>
<p>Given Checkstyle generally keeps good compatibility between versions, you can override the version used at runtime to benefit from <a class="externalLink" href="http://checkstyle.sourceforge.net/releasenotes.html">Checkstyle latest bugfixes</a>:</p>
<div class="source">
<pre><project>
@@ -211,7 +211,8 @@
</pluginManagement>
<build>
...
-</project></pre></div></div>
+</project>
+</pre></div></div>
</div>
</div>
<div class="clear">
Modified: websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/faq.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/faq.html (original)
+++ websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/faq.html Sat May 2 10:15:09 2015
@@ -1,279 +1,279 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
- | Generated by Apache Maven Doxia at 2015-04-11
- | Rendered using Apache Maven Stylus Skin 1.5
--->
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <title>Apache Maven Checkstyle Plugin – Frequently Asked Questions</title>
- <style type="text/css" media="all">
- @import url("./css/maven-base.css");
- @import url("./css/maven-theme.css");
- @import url("./css/site.css");
- </style>
- <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20150411" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
-<script type="text/javascript">_uacct = "UA-140879-1";
- urchinTracker();</script>
- </head>
- <body class="composite">
- <div id="banner">
- <a href="../../" id="bannerLeft">
- <img src="../../images/apache-maven-project-2.png" alt="" />
- </a>
- <span id="bannerRight">
- <img src="../../images/maven-logo-2.gif" alt="" />
- </span>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="breadcrumbs">
-
- <div class="xleft">
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
- <a href="../../index.html">Maven</a>
- >
- <a href="../index.html">Plugins</a>
- >
- <a href="./">Apache Maven Checkstyle Plugin</a>
- >
- Frequently Asked Questions
- </div>
- <div class="xright">
- Last Published: 2015-04-11
- | Version: 2.16-SNAPSHOT
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="leftColumn">
- <div id="navcolumn">
-
- <h5>Overview</h5>
- <ul>
- <li class="none">
- <a href="index.html">Introduction</a>
- </li>
- <li class="none">
- <a href="plugin-info.html">Goals</a>
- </li>
- <li class="none">
- <a href="usage.html">Usage</a>
- </li>
- <li class="none">
- <strong>FAQ</strong>
- </li>
- <li class="none">
- <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
- </li>
- <li class="none">
- <a href="download.html">Download</a>
- </li>
- <li class="none">
- <a href="history.html">Releases History</a>
- </li>
- </ul>
- <h5>Examples</h5>
- <ul>
- <li class="none">
- <a href="examples/upgrading-checkstyle.html">Upgrading Checkstyle at Runtime</a>
- </li>
- <li class="none">
- <a href="examples/inline-checker-config.html">Using an Inline Checkstyle Checker Configuration</a>
- </li>
- <li class="none">
- <a href="examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
- </li>
- <li class="none">
- <a href="examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a>
- </li>
- <li class="none">
- <a href="examples/suppressions-filter.html">Using a Suppressions Filter</a>
- </li>
- <li class="none">
- <a href="examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Checks</a>
- </li>
- <li class="none">
- <a href="examples/multi-module-config.html">Multimodule Configuration</a>
- </li>
- </ul>
- <h5>Project Documentation</h5>
- <ul>
- <li class="collapsed">
- <a href="project-info.html">Project Information</a>
- </li>
- <li class="collapsed">
- <a href="project-reports.html">Project Reports</a>
- </li>
- </ul>
- <h5>Maven Projects</h5>
- <ul>
- <li class="none">
- <a href="../../ant-tasks/index.html">Ant Tasks</a>
- </li>
- <li class="none">
- <a href="../../archetype/index.html">Archetype</a>
- </li>
- <li class="none">
- <a href="../../doxia/index.html">Doxia</a>
- </li>
- <li class="none">
- <a href="../../jxr/index.html">JXR</a>
- </li>
- <li class="none">
- <a href="../../ref/current">Maven</a>
- </li>
- <li class="none">
- <a href="../../pom/index.html">Parent POMs</a>
- </li>
- <li class="none">
- <a href="../index.html">Plugins</a>
- </li>
- <li class="none">
- <a href="../../plugin-testing/index.html">Plugin Testing</a>
- </li>
- <li class="none">
- <a href="../../plugin-tools/index.html">Plugin Tools</a>
- </li>
- <li class="none">
- <a href="../../apache-resource-bundles/index.html">Resource Bundles</a>
- </li>
- <li class="none">
- <a href="../../scm/index.html">SCM</a>
- </li>
- <li class="none">
- <a href="../../shared/index.html">Shared Components</a>
- </li>
- <li class="none">
- <a href="../../skins/index.html">Skins</a>
- </li>
- <li class="none">
- <a href="../../surefire/index.html">Surefire</a>
- </li>
- <li class="none">
- <a href="../../wagon/index.html">Wagon</a>
- </li>
- </ul>
- <h5>ASF</h5>
- <ul>
- <li class="none">
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
- </li>
- </ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="./images/logos/maven-feather.png"/>
- </a>
-
- </div>
- </div>
- <div id="bodyColumn">
- <div id="contentBox">
- <!-- 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. --><div class="section">
-<h2><a name="Frequently_Asked_Questions"></a><a name="top">Frequently Asked Questions</a></h2>
-<ol style="list-style-type: decimal">
-<li><a href="#Whare_is_maven_checks.xml_predefined_ruleset">Where is <tt>config/maven_checks.xml</tt> predefined ruleset?</a></li>
-<li><a href="#How_are_the_Checkstyle_properties_set">How are the Checkstyle properties set?</a></li>
-<li><a href="#How_do_I_set_a_custom_ruleset">How do I set a custom ruleset?</a></li>
-<li><a href="#How_do_I_include_the_test_directory_in_Checkstyle">How do I include the test directory in Checkstyle?</a></li>
-<li><a href="#What_is_the_difference_between_checkstyle:checkstyle_and_checkstyle:check">What is the difference between checkstyle:checkstyle and checkstyle:check?</a></li></ol></div>
-<dl>
-<dt><a name="Whare_is_maven_checks.xml_predefined_ruleset">Where is <tt>config/maven_checks.xml</tt> predefined ruleset?</a></dt>
-<dd>
-
-<p>
- Starting with maven-checkstyle-plugin version 2.15, <tt>config/maven_checks.xml</tt> predefined ruleset
- is not part of the plugin any more but has moved to
- <a href="/shared/maven-shared-resources/">Apache Maven Shared Resources</a>.
- </p>
-
-<p align="right"><a href="#top">[top]</a></p><hr /></dd>
-<dt><a name="How_are_the_Checkstyle_properties_set">How are the Checkstyle properties set?</a></dt>
-<dd>
-
-<p>
- You can set the Checkstyle properties to be used in the plugin configuration of your POM through the
- <tt>propertiesLocation</tt> parameter. The properties file will be resolved by the plugin based
- on its value.
- </p>
-
-<p align="right"><a href="#top">[top]</a></p><hr /></dd>
-<dt><a name="How_do_I_set_a_custom_ruleset">How do I set a custom ruleset?</a></dt>
-<dd>
-
-<p>
- You can set a custom ruleset through the <tt>configLocation</tt> plugin parameter. If no value is
- specified, the plugin will use a default ruleset, which is the <tt>sun_checks.xml</tt>, that is bundled with the
- plugin.
- </p>
-
-<p align="right"><a href="#top">[top]</a></p><hr /></dd>
-<dt><a name="How_do_I_include_the_test_directory_in_Checkstyle">How do I include the test directory in Checkstyle?</a></dt>
-<dd>
-
-<p>
- You can include the test directory in the Checkstyle report by setting the
- <tt>includeTestSourceDirectory</tt> plugin parameter to <tt>true</tt>.
- </p>
-
-<p align="right"><a href="#top">[top]</a></p><hr /></dd>
-<dt><a name="What_is_the_difference_between_checkstyle:checkstyle_and_checkstyle:check">What is the difference between checkstyle:checkstyle and checkstyle:check?</a></dt>
-<dd>
-
-<p>
- The checkstyle:checkstyle goal is a <b>reporting</b> goal that adds a report
- of Checkstyle violations to the output of the maven-site-plugin. The checkstyle:check goal
- is an ordinary goal that reports violations to the console and/or fails the build when there
- are violations.
- </p>
-
-<p align="right"><a href="#top">[top]</a></p></dd></dl>
- </div>
- </div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2005-2015
- The Apache Software Foundation
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
- Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- </body>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at 2015-05-02
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Apache Maven Checkstyle Plugin – Frequently Asked Questions</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <meta name="Date-Revision-yyyymmdd" content="20150502" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../../" id="bannerLeft">
+ <img src="../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ <a href="../index.html">Plugins</a>
+ >
+ <a href="./">Apache Maven Checkstyle Plugin</a>
+ >
+ Frequently Asked Questions
+ </div>
+ <div class="xright">
+ Last Published: 2015-05-02
+ | Version: 2.16-SNAPSHOT
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <a href="usage.html">Usage</a>
+ </li>
+ <li class="none">
+ <strong>FAQ</strong>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
+ </li>
+ <li class="none">
+ <a href="download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="history.html">Releases History</a>
+ </li>
+ </ul>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="examples/upgrading-checkstyle.html">Upgrading Checkstyle at Runtime</a>
+ </li>
+ <li class="none">
+ <a href="examples/inline-checker-config.html">Using an Inline Checkstyle Checker Configuration</a>
+ </li>
+ <li class="none">
+ <a href="examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
+ </li>
+ <li class="none">
+ <a href="examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a>
+ </li>
+ <li class="none">
+ <a href="examples/suppressions-filter.html">Using a Suppressions Filter</a>
+ </li>
+ <li class="none">
+ <a href="examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Checks</a>
+ </li>
+ <li class="none">
+ <a href="examples/multi-module-config.html">Multimodule Configuration</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html">Project Reports</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../ref/current">Maven</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-testing/index.html">Plugin Testing</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../apache-resource-bundles/index.html">Resource Bundles</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="./images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- 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. --><div class="section">
+<h2><a name="Frequently_Asked_Questions"></a><a name="top">Frequently Asked Questions</a></h2>
+<ol style="list-style-type: decimal">
+<li><a href="#Where_is_maven_checks.xml_predefined_ruleset">Where is <tt>config/maven_checks.xml</tt> predefined ruleset?</a></li>
+<li><a href="#How_are_the_Checkstyle_properties_set">How are the Checkstyle properties set?</a></li>
+<li><a href="#How_do_I_set_a_custom_ruleset">How do I set a custom ruleset?</a></li>
+<li><a href="#How_do_I_include_the_test_directory_in_Checkstyle">How do I include the test directory in Checkstyle?</a></li>
+<li><a href="#What_is_the_difference_between_checkstyle:checkstyle_and_checkstyle:check">What is the difference between checkstyle:checkstyle and checkstyle:check?</a></li></ol></div>
+<dl>
+<dt><a name="Where_is_maven_checks.xml_predefined_ruleset">Where is <tt>config/maven_checks.xml</tt> predefined ruleset?</a></dt>
+<dd>
+
+<p>
+ Starting with maven-checkstyle-plugin version 2.14, <tt>config/maven_checks.xml</tt> predefined ruleset
+ is not part of the plugin any more but has moved to
+ <a href="/shared/maven-shared-resources/">Apache Maven Shared Resources</a>.
+ </p>
+
+<p align="right"><a href="#top">[top]</a></p><hr /></dd>
+<dt><a name="How_are_the_Checkstyle_properties_set">How are the Checkstyle properties set?</a></dt>
+<dd>
+
+<p>
+ You can set the Checkstyle properties to be used in the plugin configuration of your POM through the
+ <tt>propertiesLocation</tt> parameter. The properties file will be resolved by the plugin based
+ on its value.
+ </p>
+
+<p align="right"><a href="#top">[top]</a></p><hr /></dd>
+<dt><a name="How_do_I_set_a_custom_ruleset">How do I set a custom ruleset?</a></dt>
+<dd>
+
+<p>
+ You can set a custom ruleset through the <tt>configLocation</tt> plugin parameter. If no value is
+ specified, the plugin will use a default ruleset, which is the <tt>sun_checks.xml</tt>, that is bundled with the
+ plugin.
+ </p>
+
+<p align="right"><a href="#top">[top]</a></p><hr /></dd>
+<dt><a name="How_do_I_include_the_test_directory_in_Checkstyle">How do I include the test directory in Checkstyle?</a></dt>
+<dd>
+
+<p>
+ You can include the test directory in the Checkstyle report by setting the
+ <tt>includeTestSourceDirectory</tt> plugin parameter to <tt>true</tt>.
+ </p>
+
+<p align="right"><a href="#top">[top]</a></p><hr /></dd>
+<dt><a name="What_is_the_difference_between_checkstyle:checkstyle_and_checkstyle:check">What is the difference between checkstyle:checkstyle and checkstyle:check?</a></dt>
+<dd>
+
+<p>
+ The checkstyle:checkstyle goal is a <b>reporting</b> goal that adds a report
+ of Checkstyle violations to the output of the maven-site-plugin. The checkstyle:check goal
+ is an ordinary goal that reports violations to the console and/or fails the build when there
+ are violations.
+ </p>
+
+<p align="right"><a href="#top">[top]</a></p></dd></dl>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2015
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
</html>
\ No newline at end of file