From 60eaeb275aa59acbaaaf0f75af6f24790795d802 Mon Sep 17 00:00:00 2001 From: jjensen Date: Sat, 23 Dec 2006 23:44:20 +0000 Subject: [PATCH] Add goals page; clarify properties. git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@489952 13f79535-47bb-0310-9956-ffa450edef68 --- pmd/project.xml | 14 ++++++++++ pmd/xdocs/changes.xml | 4 ++- pmd/xdocs/goals.xml | 53 +++++++++++++++++++++++++++++++++++++ pmd/xdocs/index.xml | 4 +++ pmd/xdocs/navigation.xml | 1 + pmd/xdocs/properties.xml | 57 +++++++++++++++++++++++++++------------- 6 files changed, 114 insertions(+), 19 deletions(-) create mode 100644 pmd/xdocs/goals.xml diff --git a/pmd/project.xml b/pmd/project.xml index ffc820cd..9b443843 100644 --- a/pmd/project.xml +++ b/pmd/project.xml @@ -76,6 +76,11 @@ 1.9 MAVEN_PMD_1_9 + + 1.10-SNAPSHOT + 1.10-SNAPSHOT + MAVEN_PMD_1_10 + @@ -131,6 +136,15 @@ Developer + + Jeff Jensen + jjensen + jjensen@apache.org + + Developer + + -6 + diff --git a/pmd/xdocs/changes.xml b/pmd/xdocs/changes.xml index 3146ce89..340f3cdd 100644 --- a/pmd/xdocs/changes.xml +++ b/pmd/xdocs/changes.xml @@ -25,10 +25,12 @@ + Add "Goals" page. + Update/clarify properties and add "Default" column to "Properties" page. Cannot run pmd with Strings rulesets. Add an alternative jsl stylesheet that includes priority information. Allow custom JSL stylesheet to be defined via a property. - 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. + 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. Upgrade to pmd-3.7. diff --git a/pmd/xdocs/goals.xml b/pmd/xdocs/goals.xml new file mode 100644 index 00000000..c1071467 --- /dev/null +++ b/pmd/xdocs/goals.xml @@ -0,0 +1,53 @@ + + + + + Maven PMD Plug-in Goals + Jeff Jensen + + +
+ + + + + + + + + + + + + + + + + + + + + +
GoalDescription
pmdIf enabled, run the pmd:report goal.
pmd:report + Run PMD on the code and generate the report. + Also, if enabled, run the pmd:cpd-report goal. +
pmd:cpd-reportRun CPD on the code and generate the report.
+
+ + diff --git a/pmd/xdocs/index.xml b/pmd/xdocs/index.xml index 2c075726..740ec3a7 100644 --- a/pmd/xdocs/index.xml +++ b/pmd/xdocs/index.xml @@ -27,6 +27,10 @@ This plugin generates a report of the PMD static source code analyzer.

+

+ To learn which release of PMD this version of the Maven PMD plugin uses, + refer to the Dependencies Report. +

See the FAQ for more information on Installation / Use / Configuring.

diff --git a/pmd/xdocs/navigation.xml b/pmd/xdocs/navigation.xml index 3702ecf0..828bed21 100644 --- a/pmd/xdocs/navigation.xml +++ b/pmd/xdocs/navigation.xml @@ -32,6 +32,7 @@ + diff --git a/pmd/xdocs/properties.xml b/pmd/xdocs/properties.xml index ef780e41..a1a2492c 100644 --- a/pmd/xdocs/properties.xml +++ b/pmd/xdocs/properties.xml @@ -22,6 +22,7 @@ Properties Siegfried Goeschl + Jeff Jensen @@ -30,11 +31,13 @@ Property Optional? + Default Description - + maven.pmd.enable No + true Enable/disable the PMD plugin. Has to be set to "true" to enable the plugin @@ -43,91 +46,109 @@ maven.pmd.rulesetfiles Yes + rulesets/basic.xml, rulesets/unusedcode.xml, rulesets/imports.xml - 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) maven.pmd.includes Yes + + **/*.java, which matches all Java source files + in the source tree (specified by the ${maven.src.dir} + property. + 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 - ${maven.src.dir}. The default value is - **/*.java, which matches all Java source files - in the source tree (specified by the ${maven.src.dir} - property. + ${maven.src.dir}. maven.pmd.excludes Yes + (no files excluded) 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 - ${maven.src.dir}. The default value is to not - exclude any files. + ${maven.src.dir}. maven.pmd.cpd.enable Yes + false - Enable/disable the CPD report. Defaults to "false". + Enable/disable the CPD report. maven.pmd.cpd.minimumtokencount Yes + 100 - 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. maven.pmd.check.tests Yes + true - Whether or not to run PMD on test sources. Defaults to true. + Whether or not to run PMD on test sources. maven.pmd.console Yes + false - Whether or not to display PMD errors to the console. Defaults to false. + Whether or not to display PMD errors to the console. maven.pmd.failonerror Yes + false - 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. maven.pmd.failonruleviolation Yes + false - 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. maven.pmd.targetjdk Yes + ${maven.compile.source} - Target JDK 1.3, 1.4, or 1.5.. Defaults to ${maven.compile.source}. + The target JDK: 1.3, 1.4, or 1.5... maven.pmd.stylesheet Yes + ${plugin.resources}/pmd.jsl A custom stylesheet to use for the report. - Default is ${plugin.resources}/pmd.jsl. An alternative stylesheet is supplied that includes priority information of pmd violations. To use it, set maven.pmd.stylesheet=${plugin.resources}/pmd-priority.jsl.