Author: adangel
Date: Sun Aug 7 09:46:55 2016
New Revision: 1755430
URL: http://svn.apache.org/viewvc?rev=1755430&view=rev
Log:
[MPMD-220] Upgrade to PMD 5.5.1 - update documentation and links
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java
maven/plugins/trunk/maven-pmd-plugin/src/main/resources/rulesets/maven.xml
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt.vm
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm
maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java?rev=1755430&r1=1755429&r2=1755430&view=diff
==============================================================================
---
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java
(original)
+++
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java
Sun Aug 7 09:46:55 2016
@@ -152,7 +152,7 @@ public class PmdReport
/**
* Source level marker used to indicate whether a RuleViolation should be
suppressed. If it is not set, PMD's
* default will be used, which is <code>NOPMD</code>. See also <a
- * href="http://pmd.sourceforge.net/usage/suppressing.html">PMD –
Suppressing warnings</a>.
+ * href="https://pmd.github.io/latest/usage/suppressing.html">PMD –
Suppressing warnings</a>.
*
* @since 3.4
*/
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/resources/rulesets/maven.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/main/resources/rulesets/maven.xml?rev=1755430&r1=1755429&r2=1755430&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/main/resources/rulesets/maven.xml
(original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/main/resources/rulesets/maven.xml
Sun Aug 7 09:46:55 2016
@@ -25,7 +25,7 @@ under the License.
<!--
Customized PMD ruleset for Maven, see [0] for more information
- [0] http://pmd.sourceforge.net/howtomakearuleset.html
+ [0] https://pmd.github.io/latest/customizing/howtomakearuleset.html
-->
<description>
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt.vm?rev=1755430&r1=1755429&r2=1755430&view=diff
==============================================================================
---
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt.vm
(original)
+++
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt.vm
Sun Aug 7 09:46:55 2016
@@ -28,10 +28,11 @@
Using Rule Sets
- The PMD plugin uses three default rule sets: <basic.xml>, <unusedcode.xml>
and <imports.xml>. These rule sets are
- bundled in the PMD code analysis tool
- (see the
{{{http://pmd.sourceforge.net/pmd-${pmdVersion}/pmd-java/rules/index.html}ruleset
index for java}} and
- the
{{{http://pmd.sourceforge.net/pmd-${pmdVersion}/pmd-javascript/rules/index.html}ruleset
index for javascript}}).
+ The PMD plugin uses five default rule sets: <basic.xml>, <empty.xml>,
<imports.xml>, <unnecessary.xml>
+ and <unusedcode.xml>. These rule sets are bundled in the PMD code analysis
tool
+ (see the
{{{https://pmd.github.io/pmd-${pmdVersion}/pmd-java/rules/index.html}ruleset
index for java}},
+ the
{{{https://pmd.github.io/pmd-${pmdVersion}/pmd-javascript/rules/index.html}ruleset
index for javascript}}
+ and
{{{https://pmd.github.io/pmd-${pmdVersion}/pmd-jsp/rules/index.html}ruleset
index for jsp}}).
To use other rule sets, you can configure it in the plugin as shown below.
The rule sets may reside in the classpath, filesystem or at a URL. For rule
sets that are bundled with the PMD tool,
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm?rev=1755430&r1=1755429&r2=1755430&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm Sun Aug 7
09:46:55 2016
@@ -25,7 +25,7 @@
${project.name}
- The PMD Plugin allows you to automatically run the
{{{http://pmd.sourceforge.net/}PMD}} code analysis tool
+ The PMD Plugin allows you to automatically run the
{{{https://pmd.github.io/}PMD}} code analysis tool
on your project's source code and generate a site report with its results.
It also supports the separate
Copy/Paste Detector tool (or CPD) distributed with PMD.
@@ -53,9 +53,7 @@ ${project.name}
* Usage
General instructions on how to use the PMD Plugin can be found on the
{{{./usage.html}usage page}}. Some more
- specific use cases are described in the examples given below. Last but not
least, users occasionally contribute
- additional examples, tips or errata to the
- {{{http://docs.codehaus.org/display/MAVENUSER/PMD+Plugin}plugin's wiki
page}}.
+ specific use cases are described in the examples given below.
In case you still have questions regarding the plugin's usage, please have a
look at the {{{./faq.html}FAQ}} and feel
free to contact the {{{./mail-lists.html}user mailing list}}. The posts to
the mailing list are archived and could
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml?rev=1755430&r1=1755429&r2=1755430&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml Sun Aug 7
09:46:55 2016
@@ -55,5 +55,18 @@ under the License.
</p>
</answer>
</faq>
+ <faq id="no report in site">
+ <question>
+ I have add the PMD/CPD reports, but they do not show up in the
generated site. Has the plugin been executed?
+ </question>
+ <answer>
+ <p>
+ If there are no violations, then by default no reports are created
and the entire PMD or CPD section
+ is not rendered in the site. To change this behaviour, set the
+ <a href="pmd-mojo.xml#skipEmptyReport">skipEmptyReport for PMD</a>
or <a href="cpd-mojo#skipEmptyReport">skipEmptyReport for CPD</a>
+ to <code>false</code>.
+ </p>
+ </answer>
+ </faq>
</part>
</faqs>
\ No newline at end of file