Update documentation about "excludes" option of offline instrumentati…

…on (bazelbuild#951)
gergelyfabian · Oct 2, 2019 · e1a9d4b · e1a9d4b
1 parent 71df272
commit e1a9d4b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/jacoco-maven-plugin/src/org/jacoco/maven/InstrumentMojo.java b/jacoco-maven-plugin/src/org/jacoco/maven/InstrumentMojo.java
@@ -55,7 +55,10 @@ public class InstrumentMojo extends AbstractJacocoMojo {
 
 	/**
 	 * A list of class files to exclude from instrumentation. May use wildcard
-	 * characters (* and ?). When not specified nothing will be excluded.
+	 * characters (* and ?). When not specified nothing will be excluded. Except
+	 * for performance optimization or technical corner cases this option is
+	 * normally not required. If you want to exclude classes from the report
+	 * please configure the <code>report</code> goal accordingly.
 	 */
 	@Parameter
 	private List<String> excludes;

diff --git a/org.jacoco.doc/docroot/doc/faq.html b/org.jacoco.doc/docroot/doc/faq.html
@@ -197,7 +197,7 @@ <h3>Why do I see classes in the coverage report although I excluded them in the
   in the report are explicitly provided. Coverage is determined from the
   provided execution data. If execution data is missing for a particular class,
   this class is shown as not covered because the report generator cannot
-  distinguish whether the class was excluded or not executed.
+  distinguish whether the class was excluded from instrumentation or not executed.
 </p>
 
 <p>