Author: jjensen
Date: Sat Dec 23 15:44:20 2006
New Revision: 489952
URL: http://svn.apache.org/viewvc?view=rev&rev=489952
Log:
Add goals page; clarify properties.
Added:
maven/maven-1/plugins/trunk/pmd/xdocs/goals.xml
Modified:
maven/maven-1/plugins/trunk/pmd/project.xml
maven/maven-1/plugins/trunk/pmd/xdocs/changes.xml
maven/maven-1/plugins/trunk/pmd/xdocs/index.xml
maven/maven-1/plugins/trunk/pmd/xdocs/navigation.xml
maven/maven-1/plugins/trunk/pmd/xdocs/properties.xml
Modified: maven/maven-1/plugins/trunk/pmd/project.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins/trunk/pmd/project.xml?view=diff&rev=489952&r1=489951&r2=489952
==============================================================================
--- maven/maven-1/plugins/trunk/pmd/project.xml (original)
+++ maven/maven-1/plugins/trunk/pmd/project.xml Sat Dec 23 15:44:20 2006
@@ -76,6 +76,11 @@
<name>1.9</name>
<tag>MAVEN_PMD_1_9</tag>
</version>
+ <version>
+ <id>1.10-SNAPSHOT</id>
+ <name>1.10-SNAPSHOT</name>
+ <tag>MAVEN_PMD_1_10</tag>
+ </version>
</versions>
<developers>
<developer>
@@ -130,6 +135,15 @@
<roles>
<role>Developer</role>
</roles>
+ </developer>
+ <developer>
+ <name>Jeff Jensen</name>
+ <id>jjensen</id>
+ <email>[EMAIL PROTECTED]</email>
+ <roles>
+ <role>Developer</role>
+ </roles>
+ <timezone>-6</timezone>
</developer>
</developers>
<contributors>
Modified: maven/maven-1/plugins/trunk/pmd/xdocs/changes.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins/trunk/pmd/xdocs/changes.xml?view=diff&rev=489952&r1=489951&r2=489952
==============================================================================
--- maven/maven-1/plugins/trunk/pmd/xdocs/changes.xml (original)
+++ maven/maven-1/plugins/trunk/pmd/xdocs/changes.xml Sat Dec 23 15:44:20 2006
@@ -25,10 +25,12 @@
</properties>
<body>
<release version="1.10-SNAPSHOT" date="In SVN">
+ <action dev="jjensen" type="add">Add "Goals" page.</action>
+ <action dev="jjensen" type="update">Update/clarify properties and add
"Default" column to "Properties" page.</action>
<action dev="ltheussl" type="fix" issue="MPPMD-30">Cannot run pmd with
Strings rulesets.</action>
<action dev="ltheussl" type="add" due-to="James Dempsey">Add an
alternative jsl stylesheet that includes priority information.</action>
<action dev="ltheussl" type="add" issue="MPPMD-27">Allow custom JSL
stylesheet to be defined via a property.</action>
- <action dev="aheritier" type="update">Update dependencies to unify them
between plugins. The following dependencies are updated : jaxen v1.0-FCS-full
to 1.1-beta-9. The following dependencies are removed : saxpath.</action>
+ <action dev="aheritier" type="update">Update dependencies to unify them
between plugins. The following dependencies are updated: jaxen v1.0-FCS-full to
1.1-beta-9. The following dependencies are removed: saxpath.</action>
<action dev="aheritier" type="update">Upgrade to pmd-3.7.</action>
</release>
<release version="1.9" date="2006-04-27">
Added: maven/maven-1/plugins/trunk/pmd/xdocs/goals.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins/trunk/pmd/xdocs/goals.xml?view=auto&rev=489952
==============================================================================
--- maven/maven-1/plugins/trunk/pmd/xdocs/goals.xml (added)
+++ maven/maven-1/plugins/trunk/pmd/xdocs/goals.xml Sat Dec 23 15:44:20 2006
@@ -0,0 +1,53 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed 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.
+ */
+ -->
+<document>
+ <properties>
+ <title>Maven PMD Plug-in Goals</title>
+ <author email="[EMAIL PROTECTED]">Jeff Jensen</author>
+ </properties>
+ <body>
+ <section name="Goals">
+ <table>
+ <tr>
+ <th>Goal</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>pmd</td>
+ <td>If enabled, run the pmd:report goal.</td>
+ </tr>
+ <tr>
+ <td>pmd:report</td>
+ <td>
+ Run PMD on the code and generate the report.
+ Also, if enabled, run the pmd:cpd-report goal.
+ </td>
+ </tr>
+ <tr>
+ <td>pmd:cpd-report</td>
+ <td>Run CPD on the code and generate the report.</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
Modified: maven/maven-1/plugins/trunk/pmd/xdocs/index.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins/trunk/pmd/xdocs/index.xml?view=diff&rev=489952&r1=489951&r2=489952
==============================================================================
--- maven/maven-1/plugins/trunk/pmd/xdocs/index.xml (original)
+++ maven/maven-1/plugins/trunk/pmd/xdocs/index.xml Sat Dec 23 15:44:20 2006
@@ -28,6 +28,10 @@
analyzer.
</p>
<p>
+ To learn which release of PMD this version of the Maven PMD plugin
uses,
+ refer to the <a href="dependencies.html">Dependencies Report</a>.
+ </p>
+ <p>
See the <a href="faq.html">FAQ</a> for more information on Installation
/ Use / Configuring.
</p>
<subsection name="Thanks to ...">
Modified: maven/maven-1/plugins/trunk/pmd/xdocs/navigation.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins/trunk/pmd/xdocs/navigation.xml?view=diff&rev=489952&r1=489951&r2=489952
==============================================================================
--- maven/maven-1/plugins/trunk/pmd/xdocs/navigation.xml (original)
+++ maven/maven-1/plugins/trunk/pmd/xdocs/navigation.xml Sat Dec 23 15:44:20
2006
@@ -32,6 +32,7 @@
<menu name="Home">
<item name="About" href="/index.html"/>
<item name="FAQs" href="/faq.html"/>
+ <item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
<item name="Sample" href="/images/sample.gif" target="_blank"/>
</menu>
Modified: maven/maven-1/plugins/trunk/pmd/xdocs/properties.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins/trunk/pmd/xdocs/properties.xml?view=diff&rev=489952&r1=489951&r2=489952
==============================================================================
--- maven/maven-1/plugins/trunk/pmd/xdocs/properties.xml (original)
+++ maven/maven-1/plugins/trunk/pmd/xdocs/properties.xml Sat Dec 23 15:44:20
2006
@@ -22,6 +22,7 @@
<properties>
<title>Properties</title>
<author email="[EMAIL PROTECTED]">Siegfried Goeschl</author>
+ <author email="[EMAIL PROTECTED]">Jeff Jensen</author>
</properties>
<body>
@@ -30,11 +31,13 @@
<tr>
<th>Property</th>
<th>Optional?</th>
+ <th>Default</th>
<th>Description</th>
- </tr>
+ </tr>
<tr>
<td>maven.pmd.enable</td>
<td>No</td>
+ <td>true</td>
<td>
Enable/disable the PMD plugin. Has to be set to "true"
to enable the plugin
@@ -43,91 +46,109 @@
<tr>
<td>maven.pmd.rulesetfiles</td>
<td>Yes</td>
+ <td>rulesets/basic.xml, rulesets/unusedcode.xml,
rulesets/imports.xml</td>
<td>
- Defines the rule to be used for running PMD. Is
- already defined in the plugin
+ Defines the rule sets that PMD uses to scan the code
+ checking for violations.
+ Comma separated list.
+ Can specify rulesets that ship with PMD
+ (in the PMD jar, which are all in the "rulesets" package)
+ and custom rulesets of PMD rules and/or your own rules.
+ (suggestion is to specify custom rule jars as a project
+ dependency so Maven automatically puts them on the classpath
+ and PMD will automatically find them)
</td>
</tr>
<tr>
<td>maven.pmd.includes</td>
<td>Yes</td>
<td>
+ **/*.java, which matches all Java source files
+ in the source tree (specified by the <code>${maven.src.dir}</code>
+ property.
+ </td>
+ <td>
Specifies a comma-separated list of Ant patterns to use
when matching files in the source tree to be included in the
PMD report. The pattern specified is relative to
- <code>${maven.src.dir}</code>. The default value is
- <code>**/*.java</code>, which matches all Java source files
- in the source tree (specified by the <code>${maven.src.dir}</code>
- property.
+ <code>${maven.src.dir}</code>.
</td>
</tr>
<tr>
<td>maven.pmd.excludes</td>
<td>Yes</td>
+ <td>(no files excluded)</td>
<td>
Specifies a comma-separated list of Ant patterns to use when
matching files in the source tree to be excluded from the
PMD report. The pattern specified is relative to
- <code>${maven.src.dir}</code>. The default value is to not
- exclude any files.
+ <code>${maven.src.dir}</code>.
</td>
</tr>
<tr>
<td>maven.pmd.cpd.enable</td>
<td>Yes</td>
+ <td>false</td>
<td>
- Enable/disable the CPD report. Defaults to "false".
+ Enable/disable the CPD report.
</td>
</tr>
<tr>
<td>maven.pmd.cpd.minimumtokencount</td>
<td>Yes</td>
+ <td>100</td>
<td>
- Specifies the minimal number required to consider two sequences of
- tokens identical. Defaults to "100".
+ Specifies the minimum number of tokens required
+ to consider two sequences of tokens identical.
</td>
</tr>
<tr>
<td>maven.pmd.check.tests</td>
<td>Yes</td>
+ <td>true</td>
<td>
- Whether or not to run PMD on test sources. Defaults to true.
+ Whether or not to run PMD on test sources.
</td>
</tr>
<tr>
<td>maven.pmd.console</td>
<td>Yes</td>
+ <td>false</td>
<td>
- Whether or not to display PMD errors to the console. Defaults to
false.
+ Whether or not to display PMD errors to the console.
</td>
</tr>
<tr>
<td>maven.pmd.failonerror</td>
<td>Yes</td>
+ <td>false</td>
<td>
- Whether or not to fail the build if any errors occur while
processing the files. Defaults to false.
+ Whether or not to fail the build if any errors occur
+ while processing the files.
</td>
</tr>
<tr>
<td>maven.pmd.failonruleviolation</td>
<td>Yes</td>
+ <td>false</td>
<td>
- Whether or not to fail the build if PMD finds any problems.
Defaults to false.
+ Whether or not to fail the build if PMD finds any rule violations.
</td>
</tr>
<tr>
<td>maven.pmd.targetjdk</td>
<td>Yes</td>
+ <td>${maven.compile.source}</td>
<td>
- Target JDK 1.3, 1.4, or 1.5.. Defaults to ${maven.compile.source}.
+ The target JDK: 1.3, 1.4, or 1.5...
</td>
</tr>
<tr>
<td>maven.pmd.stylesheet</td>
<td>Yes</td>
+ <td>${plugin.resources}/pmd.jsl</td>
<td>
A custom stylesheet to use for the report.
- Default is <code>${plugin.resources}/pmd.jsl</code>.
An alternative stylesheet is supplied that includes
priority information of pmd violations. To use it, set
<code>maven.pmd.stylesheet=${plugin.resources}/pmd-priority.jsl</code>.
