Skip to content

Commit e1a9d4b

Browse files
Godinmarchof
authored andcommitted
Update documentation about "excludes" option of offline instrumentation (#951)
1 parent 71df272 commit e1a9d4b

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

jacoco-maven-plugin/src/org/jacoco/maven/InstrumentMojo.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,10 @@ public class InstrumentMojo extends AbstractJacocoMojo {
5555

5656
/**
5757
* A list of class files to exclude from instrumentation. May use wildcard
58-
* characters (* and ?). When not specified nothing will be excluded.
58+
* characters (* and ?). When not specified nothing will be excluded. Except
59+
* for performance optimization or technical corner cases this option is
60+
* normally not required. If you want to exclude classes from the report
61+
* please configure the <code>report</code> goal accordingly.
5962
*/
6063
@Parameter
6164
private List<String> excludes;

org.jacoco.doc/docroot/doc/faq.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ <h3>Why do I see classes in the coverage report although I excluded them in the
197197
in the report are explicitly provided. Coverage is determined from the
198198
provided execution data. If execution data is missing for a particular class,
199199
this class is shown as not covered because the report generator cannot
200-
distinguish whether the class was excluded or not executed.
200+
distinguish whether the class was excluded from instrumentation or not executed.
201201
</p>
202202

203203
<p>

0 commit comments

Comments
 (0)