You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ad...@apache.org on 2020/12/11 11:33:05 UTC

[maven-pmd-plugin] 01/01: [MPMD-311] - Improve excludesFile docs

This is an automated email from the ASF dual-hosted git repository.

adangel pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-pmd-plugin.git

commit 3e619c09e3ffdab7fd06ac48ca65767e90147148
Author: Andreas Dangel <ad...@apache.org>
AuthorDate: Fri Dec 11 12:31:17 2020 +0100

    [MPMD-311] - Improve excludesFile docs
---
 src/site/apt/examples/violation-exclusions.apt.vm | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/src/site/apt/examples/violation-exclusions.apt.vm b/src/site/apt/examples/violation-exclusions.apt.vm
index 3d94032..0b512d6 100644
--- a/src/site/apt/examples/violation-exclusions.apt.vm
+++ b/src/site/apt/examples/violation-exclusions.apt.vm
@@ -62,11 +62,14 @@ Violation Exclusions
 </project>
 +-----+
 
-  For cpd check, you can exclude classes to not verify. The properties file must have the following format:
-  
-  The differences here are that:
-  [[1]] org.apache.maven.ClassA and org.apache.maven.ClassB contain duplicated code across classes.
-  [[2]] org.apache.maven.ClassC and org.apache.maven.ClassD do not share duplicate code, but have duplicated code internally.
+  For cpd check, you can exclude classes to not verify. Classes can be specified in two ways:
+
+    [[1]] Comma-separated: org.apache.maven.ClassA and org.apache.maven.ClassB contain duplicated code across classes.
+
+    [[2]] Single class per line: org.apache.maven.ClassC and org.apache.maven.ClassD do not share duplicate code,
+    but have duplicated code internally.
+
+  The properties file for cpd must have the following format:
 
 +-----+
 org.apache.maven.ClassA,org.apache.maven.ClassB