rmuir commented on a change in pull request #119:
URL: https://github.com/apache/lucene/pull/119#discussion_r624467798
##########
File path: help/tests.txt
##########
@@ -156,6 +156,16 @@ to increase the top-N count:
gradlew -p lucene/core test -Ptests.profile=true -Ptests.profile.count=100
+Generating Coverage Reports
+------------------------------
+
+Adding the property "tests.coverage=true" will run the tests with
instrumentation to
+record coverage. The "jacocoTestReport" target will generate a report from
those files.
+
+Example:
+
+gradlew -p lucene/core -Ptests.coverage=true test jacocoTestReport
Review comment:
Well, anything making this easier to use would be great!
I really wanted the help documentation to show two phases:
1. instrumented test execution (must be opt-in with some parameter)
2. report generation
But it made things too confusing: e.g. say you make this mistake:
```console
$ gradlew -Ptests.coverage=true test
$ gradlew jacocoTestReport
```
In that case jacoco plugin is never applied and so you get a crazy error
message for missing task `jacocoTestReport`. You must also add
`-Ptests.coverage=true` to this secondary reporting task, or it won't work.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
