You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2013/02/08 22:21:06 UTC
svn commit: r1444247 - in /maven/plugins/trunk/maven-pmd-plugin/src/site:
apt/examples/violation-exclusions.apt.vm site.xml
Author: olamy
Date: Fri Feb 8 21:21:06 2013
New Revision: 1444247
URL: http://svn.apache.org/r1444247
Log:
add documentation for MPMD-161
Added:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violation-exclusions.apt.vm (with props)
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml
Added: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violation-exclusions.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violation-exclusions.apt.vm?rev=1444247&view=auto
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violation-exclusions.apt.vm (added)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violation-exclusions.apt.vm Fri Feb 8 21:21:06 2013
@@ -0,0 +1,77 @@
+ ------
+ Violation Exclusions
+ ------
+ 2013-02-08
+ ------
+
+ ~~ 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
+
+Violation Exclusions
+
+ Since version 3.0 it is possible to excluse some sources from pmd/cpd check to prevent failure.
+
++-----+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-pmd-plugin</artifactId>
+ <version>${project.version}</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ <configuration>
+ <excludeFromFailureFile>exclude-pmd.properties</excludeFromFailureFile>
+ </configuration>
+ </execution>
+ <execution>
+ <goals>
+ <goal>cpd-check</goal>
+ </goals>
+ <configuration>
+ <excludeFromFailureFile>exclude-cpd.properties</excludeFromFailureFile>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
++-----+
+
+ For cpd check, you can exclude classes to not verify. The properties file must have the following format:
+
++-----+
+org.apache.maven.ClassA,org.apache.maven.ClassB
++-----+
+
+ For pmd check, you can exclude rules per classes. The properties file must have the following format:
+
++-----+
+org.apache.maven.ClassA=UnusedPrivateField,EmptyCatchBlock
+org.apache.maven.ClassB=UnusedPrivateField,UnusedFormalParameter,UnusedPrivateMethod
++-----+
+
Propchange: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violation-exclusions.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violation-exclusions.apt.vm
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
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=1444247&r1=1444246&r2=1444247&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml Fri Feb 8 21:21:06 2013
@@ -36,6 +36,7 @@ under the License.
<item name="Using Rule Sets" href="examples/usingRuleSets.html"/>
<item name="Violation Checking" href="examples/violationChecking.html"/>
<item name="Analyzing JavaScript" href="examples/javascriptReport.html"/>
+ <item name="Violations Exclusions" href="examples/violation-exclusions.html"/>
</menu>
</body>
</project>