[jira] (MCHECKSTYLE-197) Documentation: Check goal is incorrectly described

["Stephen Colebourne (JIRA)" <ji...@codehaus.org>]

Stephen Colebourne created MCHECKSTYLE-197:
----------------------------------------------

             Summary: Documentation: Check goal is incorrectly described
                 Key: MCHECKSTYLE-197
                 URL: https://jira.codehaus.org/browse/MCHECKSTYLE-197
             Project: Maven 2.x Checkstyle Plugin
          Issue Type: Bug
    Affects Versions: 2.10
            Reporter: Stephen Colebourne


The website describes the check goal as

{panel}
checkstyle:check performs 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.{panel}

This is incorrect. The check goal will, by default, run the actual checkstyle analysis before printing the messages.

The following text would be better on the home page:
http://maven.apache.org/plugins/maven-checkstyle-plugin/index.html

{panel}
* checkstyle:checkstyle - a reporting task that performs Checkstyle analysis and generates an HTML report on violations.
* checkstyle:checkstyle-aggregate - a reporting task that performs Checkstyle analysis and generates an aggregate HTML report on violations in a multi-module reactor build.
* checkstyle:check - performs Checkstyle analysis and outputs violations to the console, potentially failing the build. It can also be configured to re-use an earlier analysis.
{panel}

The description on the check-mojo page should also be fixed similarly:
http://maven.apache.org/plugins/maven-checkstyle-plugin/check-mojo.html

An example or FAQ should be added to emphasise the difference between the checkstyle and check goals.


--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira