Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sammy-1234 authored and Sameer Arora committed Jul 29, 2019
1 parent d7257b6 commit 8defd44
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions examples/src/scala/org/pantsbuild/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,18 +129,18 @@ As an example, scoverage reports for the `example` project can be generated as:
:::bash
./pants --scoverage-enable-scoverage test examples/tests/scala/org/pantsbuild/example/hello/welcome

Scoverage supports the following options:
`--scoverage-enable-scoverage` (required)
Scoverage supports the following options:
`--scoverage-enable-scoverage` (required)
Specifies whether to generate scoverage reports for scala test targets.
Default value is False. If True, implies `--test-junit-coverage-processor=scoverage.`

`--scoverage-report-target-filters` (optional)
`--scoverage-report-target-filters` (optional)
Regex patterns passed to scoverage report generator, specifying which targets should be
included in reports. All targets matching any of the patterns will be
included when generating reports. If no targets are specified, all
targets are included, which would be the same as specifying ".*" as a filter.

`--scoverage-blacklist-targets` (optional; troubleshooting)
`--scoverage-blacklist-targets` (optional; troubleshooting)
Scoverage works by instrumenting targets at compile time. However, some targets cannot be
instrumented at all as doing so results in exceeding JVM code size limits. Thus, if you receive
the following error when compiling with scoverage:
Expand Down

0 comments on commit 8defd44

Please sign in to comment.