You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2007/12/28 02:38:29 UTC
svn commit: r607155 - in /maven/plugins/trunk/maven-pmd-plugin/src:
main/java/org/apache/maven/plugin/pmd/ site/ site/apt/ site/apt/examples/
site/fml/
Author: dennisl
Date: Thu Dec 27 17:38:28 2007
New Revision: 607155
URL: http://svn.apache.org/viewvc?rev=607155&view=rev
Log:
Documentation update:
- Fix errors and typos
- Add more @since information
- Add some formating
- Extract "How to remove a report" from the faq into an example
- Move to an fml based faq
- Use new license headers
Added:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt (with props)
maven/plugins/trunk/maven-pmd-plugin/src/site/fml/
maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml (with props)
Removed:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/faq.apt
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java Thu Dec 27 17:38:28 2007
@@ -118,10 +118,10 @@
/**
* A list of files to include from checking. Can contain ant-style wildcards and double wildcards.
- * Defaults to **\/*.java
+ * Defaults to **\/*.java.
*
- * @since 2.2
* @parameter
+ * @since 2.2
*/
private String[] includes;
@@ -129,7 +129,7 @@
/**
- * The source directories containing the sources to be compiled.
+ * The directories containing the sources to be compiled.
*
* @parameter expression="${project.compileSourceRoots}"
* @required
@@ -138,7 +138,7 @@
private List compileSourceRoots;
/**
- * The source directories containing the test-sources to be compiled.
+ * The directories containing the test-sources to be compiled.
*
* @parameter expression="${project.testCompileSourceRoots}"
* @required
@@ -149,13 +149,13 @@
/**
* The project source directories that should be excluded.
*
- * @since 2.2
* @parameter
+ * @since 2.2
*/
private List excludeRoots;
/**
- * Run PMD on the tests
+ * Run PMD on the tests.
*
* @parameter default-value="false"
* @since 2.2
Modified: maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java Thu Dec 27 17:38:28 2007
@@ -83,7 +83,7 @@
protected boolean aggregate;
/**
- * Print details of check failures to build output
+ * Print details of check failures to build output.
*
* @parameter expression="${pmd.verbose}" default-value="false"
*/
Modified: maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java Thu Dec 27 17:38:28 2007
@@ -42,7 +42,8 @@
import org.apache.maven.reporting.MavenReportException;
/**
- * Report for PMD's CPD tool. See <a href="http://pmd.sourceforge.net/cpd.html">http://pmd.sourceforge.net/cpd.html</a>
+ * Creates a report for PMD's CPD tool. See
+ * <a href="http://pmd.sourceforge.net/cpd.html">http://pmd.sourceforge.net/cpd.html</a>
* for more detail.
*
* @author Mike Perham
@@ -61,8 +62,8 @@
private int minimumTokens;
/**
- * Skip the PMD report generation. Most useful on the command line
- * via "-Dmaven.cpd.skip=true".
+ * Skip the CPD report generation. Most useful on the command line
+ * via "-Dcpd.skip=true".
*
* @parameter expression="${cpd.skip}" default-value="false"
*/
@@ -72,6 +73,7 @@
* The file encoding to use when reading the java source.
*
* @parameter
+ * @since 2.3
*/
private String sourceEncoding;
Modified: maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java Thu Dec 27 17:38:28 2007
@@ -41,7 +41,7 @@
/**
* Skip the CPD violation checks. Most useful on the command line
- * via "-Dmaven.cpd.skip=true".
+ * via "-Dcpd.skip=true".
*
* @parameter expression="${cpd.skip}" default-value="false"
*/
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=607155&r1=607154&r2=607155&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 Thu Dec 27 17:38:28 2007
@@ -59,7 +59,7 @@
import org.codehaus.plexus.resource.loader.ResourceNotFoundException;
/**
- * Implement the PMD report.
+ * Creates a PMD report.
*
* @author Brett Porter
* @version $Id: PmdReport.java,v 1.3 2005/02/23 00:08:53 brett Exp $
@@ -71,8 +71,11 @@
{
/**
* The target JDK to analyse based on. Should match the target used in the compiler plugin. Valid values are
- * currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code>, <code>1.6</code>.
- *
+ * currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code> and <code>1.6</code>.
+ * <p>
+ * <b>Note:</b> support for <code>1.6</code> was added in version 2.3 of this plugin.
+ * </p>
+ *
* @parameter expression="${targetJdk}"
*/
private String targetJdk;
@@ -87,7 +90,7 @@
/**
* Skip the PMD report generation. Most useful on the command line
- * via "-Dmaven.pmd.skip=true".
+ * via "-Dpmd.skip=true".
*
* @parameter expression="${pmd.skip}" default-value="false"
*/
Modified: maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java Thu Dec 27 17:38:28 2007
@@ -51,7 +51,7 @@
/**
* Skip the PMD checks. Most useful on the command line
- * via "-Dmaven.pmd.skip=true".
+ * via "-Dpmd.skip=true".
*
* @parameter expression="${pmd.skip}" default-value="false"
*/
Added: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt?rev=607155&view=auto
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt (added)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt Thu Dec 27 17:38:28 2007
@@ -0,0 +1,57 @@
+ ------
+ Remove Report
+ ------
+ Dennis Lundberg
+ ------
+ 2007-12-28
+ ------
+
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Remove Report
+
+ You may want to generate only one of the reports, but not the other. To do
+ this you can use the <<<\<reportSets\>>>> feature within your POM. Below is
+ the default configuration for the plugin. To disable one of the reports,
+ just copy the <<<\<reportSets\>>>> element below to your POM and remove the
+ <<<\<report\>>>> you don't want to generate.
+
++--------------------+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <artifactId>maven-pmd-plugin</artifactId>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>pmd</report>
+ <report>cpd</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
++--------------------+
Propchange: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt
------------------------------------------------------------------------------
svn:keywords = Date Revision Author Id
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt Thu Dec 27 17:38:28 2007
@@ -6,28 +6,35 @@
30 June 2006
------
-~~ 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.
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you 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.
~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+~~ http://maven.apache.org/doxia/references/apt-format.html
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 ({{{http://pmd.sourceforge.net/rules/index.html}more info}}). To use other
- rule sets, you can configure the plugin as shown below:
+ 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 ({{{http://pmd.sourceforge.net/rules/index.html}more info}}). 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,
+ you do not need to specificy the absolute path of the file. It will be resolved by the plugin. But if the rule set is a
+ custom rule set, you need to specify its absolute path.
+-----+
<project>
@@ -39,9 +46,12 @@
<artifactId>maven-pmd-plugin</artifactId>
<configuration>
<rulesets>
+ <!-- Two rule sets that come bundled with PMD -->
<ruleset>/rulesets/braces.xml</ruleset>
<ruleset>/rulesets/naming.xml</ruleset>
+ <!-- Custom local file system rule set -->
<ruleset>d:\rulesets\strings.xml</ruleset>
+ <!-- Custom remote rule set accessed via a URL -->
<ruleset>http://localhost/design.xml</ruleset>
</rulesets>
</configuration>
@@ -51,7 +61,3 @@
...
</project>
+-----+
-
- The rulesets may reside in the classpath, filesystem or at a URL. For rule sets that are already bundled with the PMD tool,
- you do not need to specificy the absolute path of the file. It will be resolved by the plugin. But if the rule set is a
- custom rule set, you need to specify its absolute path.
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt Thu Dec 27 17:38:28 2007
@@ -4,29 +4,32 @@
23 June 2006
------
-~~ 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.
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you 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.
~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+~~ http://maven.apache.org/doxia/references/apt-format.html
Violation Checking
- The pmd:check and pmd:cpd-check goals allow you to configure your build to fail if any errors are found in the PMD or
- CPD reports respectively and, in doing so, enforce your own custom code quality rules.
+ The <<<pmd:check>>> and <<<pmd:cpd-check>>> goals allow you to configure your build to fail if any errors are found
+ in the PMD or CPD reports respectively. In doing so you can enforce your own custom code quality rules.
- The rule violations may optionally be displayed on the build output using the verbose setting.
+ The rule violations may optionally be displayed on the build output using the <<<verbose>>> setting.
The following code fragment enables both the standard PMD check and the CPD check in a build, during the <<<verify>>>
phase.
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt Thu Dec 27 17:38:28 2007
@@ -4,22 +4,22 @@
06 January 2006
------
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you 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.
Maven 2 PMD Plugin
@@ -27,7 +27,7 @@
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.
- The plugin accepts configuration parameters that will be used to customize the execution of the PMD tool.
+ The plugin accepts configuration parameters that can be used to customize the execution of the PMD tool.
* Goals Overview
@@ -40,11 +40,11 @@
* {{{cpd-mojo.html}pmd:cpd}} generates a report for PMD's Copy/Paste Detector (CPD) tool. It can also
generate a cpd results file in any of these formats: xml, csv or txt.
- * {{{check-mojo.html}pmd:check}} verifies that the PMD report is empty and fail the build if it is not. This goal is executed by
+ * {{{check-mojo.html}pmd:check}} verifies that the PMD report is empty and fails the build if it is not. This goal is executed by
default when <<<pmd:pmd>>> is executed.
- * {{{cpd-check-mojo.html}pmd:cpd-check}} verifies that the CPD report is empty and fail the build if it is not. This goal is also
- executed by default when <<<pmd:cpd>>>> is executed.
+ * {{{cpd-check-mojo.html}pmd:cpd-check}} verifies that the CPD report is empty and fails the build if it is not. This goal is
+ executed by default when <<<pmd:cpd>>> is executed.
* Usage
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt Thu Dec 27 17:38:28 2007
@@ -6,22 +6,22 @@
23 June 2006
------
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you 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.
Usage
@@ -76,10 +76,10 @@
encoding to use when reading the java source. Note also the ability to exclude source which you want
to ignore.
- You can configure the minimum code size which trips the CPD. The default of 100 tokens corresponds
- to approxiamately 5-10 lines of code.
+ You can configure the minimum code size which trips the CPD. The default of <<<100>>> tokens corresponds
+ to approximately 5-10 lines of code.
- Since PMD parses the Java source, it needs to know which Java version to use. The default is 1.4.
+ Since PMD parses the Java source, it needs to know which Java version to use. The default is <<<1.4>>>.
The following is a possible configuration:
+-----+
Added: 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=607155&view=auto
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml (added)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml Thu Dec 27 17:38:28 2007
@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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.
+-->
+
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="Is there any way to skip the PMD or CPD reports temporarily">
+ <question>
+ The PMD report takes a long time to generate. Is there any way to skip
+ the PMD or CPD reports temporarily?
+ </question>
+ <answer>
+ <p>
+ Yes, each report supports a skip parameter which you can pass on the
+ command line, <code>-Dpmd.skip=true</code> and
+ <code>-Dcpd.skip=true</code> respectively.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
Propchange: maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml
------------------------------------------------------------------------------
svn:keywords = Date Revision Author Id
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml?rev=607155&r1=607154&r2=607155&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml Thu Dec 27 17:38:28 2007
@@ -9,7 +9,7 @@
"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
+ 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
@@ -28,6 +28,7 @@
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
+ <item name="Remove Report" href="examples/removeReport.html"/>
<item name="Using Rule Sets" href="examples/usingRuleSets.html"/>
<item name="Violation Checking" href="examples/violationChecking.html"/>
</menu>