Take checkstyle:report-internal from checkstyle:run

Improve docs

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@292574 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
carlos 2005-09-29 23:01:26 +00:00
parent 327675ca70
commit 5e7325ad78

View File

@ -39,20 +39,16 @@
<assert:assertPluginAvailable groupId="maven" artifactId="maven-xdoc-plugin" minRelease="1.10" neededBy="${plugin.artifactId}"/> <assert:assertPluginAvailable groupId="maven" artifactId="maven-xdoc-plugin" minRelease="1.10" neededBy="${plugin.artifactId}"/>
</j:if> </j:if>
<!--
======================================================================== <!-- ======================================================================== -->
Default goal.
======================================================================== <goal name="checkstyle" description="Call checkstyle:report"
-->
<goal name="checkstyle" description="Perform checkstyle checks"
prereqs="checkstyle:report"/> prereqs="checkstyle:report"/>
<!--
======================================================================== <!-- ======================================================================== -->
Initializations.
======================================================================== <goal name="checkstyle:init" description="Initialize plugin">
-->
<goal name="checkstyle:init">
<j:if test="${sourcesPresent == 'true'}"> <j:if test="${sourcesPresent == 'true'}">
@ -97,14 +93,11 @@
</goal> </goal>
<!--
======================================================================== <!-- ======================================================================== -->
Generate a checkstyle report by running checkstyle on the project
source code.
========================================================================
-->
<goal name="checkstyle:report" <goal name="checkstyle:report"
description="Perform checkstyle checks" description="Run checkstyle on project source code and generate reports"
prereqs="checkstyle:init"> prereqs="checkstyle:init">
<j:if test="${sourcesPresent == 'true'}"> <j:if test="${sourcesPresent == 'true'}">
@ -132,11 +125,15 @@
</j:if> </j:if>
<attainGoal name="checkstyle:run"/> <attainGoal name="checkstyle:run"/>
<attainGoal name="checkstyle:report-internal"/>
</j:if> </j:if>
</goal> </goal>
<goal name="checkstyle:run">
<!-- ======================================================================== -->
<goal name="checkstyle:run" description="Run checkstyle on the sources and generate the xml report">
<!-- Create the directory for the checkstyle cache in case it doesn't <!-- Create the directory for the checkstyle cache in case it doesn't
exist already --> exist already -->
@ -152,7 +149,7 @@
</j:when> </j:when>
<j:otherwise> <j:otherwise>
<echo>The locale defined in maven.xdoc.locale.default is invalid.</echo> <echo>The locale defined in maven.xdoc.locale.default is invalid.</echo>
<echo>As Coutry code we'll use EN instead.</echo> <echo>As Country code we'll use EN instead.</echo>
<j:set var="localeCountry" value="EN"/> <j:set var="localeCountry" value="EN"/>
</j:otherwise> </j:otherwise>
</j:choose> </j:choose>
@ -205,7 +202,6 @@
</j:forEach> </j:forEach>
</j:if> </j:if>
<ant:classpath> <ant:classpath>
<ant:path refid="maven.dependency.classpath"/> <ant:path refid="maven.dependency.classpath"/>
<ant:pathelement path="${maven.build.dest}"/> <ant:pathelement path="${maven.build.dest}"/>
@ -226,6 +222,13 @@
</ant:checkstyle> </ant:checkstyle>
</goal>
<!-- ======================================================================== -->
<goal name="checkstyle:report-internal" description="Generate xdocs from checkstyle xml report">
<doc:jsl <doc:jsl
input="${maven.build.dir}/checkstyle-raw-report.xml" input="${maven.build.dir}/checkstyle-raw-report.xml"
output="checkstyle-report.xml" output="checkstyle-report.xml"
@ -254,12 +257,10 @@
</goal> </goal>
<!--
======================================================================== <!-- ======================================================================== -->
Register a Checkstyle report to the "site" plugin.
======================================================================== <goal name="maven-checkstyle-plugin:register" description="Register a Checkstyle report to the site plugin">
-->
<goal name="maven-checkstyle-plugin:register">
<j:if test="${sourcesPresent == 'true'}"> <j:if test="${sourcesPresent == 'true'}">
<doc:registerReport <doc:registerReport
name="Checkstyle" name="Checkstyle"
@ -269,18 +270,18 @@
</j:if> </j:if>
</goal> </goal>
<!--
======================================================================== <!-- ======================================================================== -->
Deregister a Checkstyle report to the "site" plugin.
======================================================================== <goal name="maven-checkstyle-plugin:deregister" description="Deregister a Checkstyle report to the site plugin.">
-->
<goal name="maven-checkstyle-plugin:deregister">
<j:if test="${sourcesPresent == 'true'}"> <j:if test="${sourcesPresent == 'true'}">
<doc:deregisterReport name="Checkstyle"/> <doc:deregisterReport name="Checkstyle"/>
</j:if> </j:if>
</goal> </goal>
<!-- ======================================================================== -->
<!-- Generate a report filtering errors by severity --> <!-- Generate a report filtering errors by severity -->
<define:taglib uri="checkstyle"> <define:taglib uri="checkstyle">