Plugin documentation

Goals available for this plugin:

Goal Report? Description
checkstyle:help No Display help information on 'org.apache.maven.plugins:maven-checkstyle-plugin' plugin. Call 'mvn checkstyle:help -Ddetail=true' to display all details.
checkstyle:check No Perform a violation check against the last Checkstyle run to see if there are any violations. It reads the Checkstyle output file, counts the number of violations found and displays it on the console.
checkstyle:checkstyle Yes Perform a Checkstyle analysis, and generate a report on violations.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 2.0
JDK 1.4
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You could run 'mvn -up' to get the latest version of this plugin, or specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins<groupId>
          <artifactId>maven-checkstyle-plugin<artifactId>
          <version>2.2<version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins<groupId>
        <artifactId>maven-checkstyle-plugin<artifactId>
        <version>2.2<version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins<groupId>
        <artifactId>maven-checkstyle-plugin<artifactId>
        <version>2.2<version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>
For more information, see "Guide to Configuring Plug-ins"