Skip to content

Remove coverage docs from usage. Describe code coverage process in internals #15152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/_docs/internals/coverage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
layout: doc-page
title: "Code Coverage for Scala 3"
---

## Instrument code for coverage analysis

[PR#13880](https://github.com/lampepfl/dotty/pull/13880) has implemented code coverage support for Dotty.
In general, code coverage "instruments" the program at compile time: code is inserted to record which statement are called. This does not change the behavior of the program. Also, a list of all the coverable statements is produced.

To use this feature, add the compile option `-coverage-out:DIR`, where `DIR` is the destination of the measurement files.

You can also set `-sourceroot:PATHS_ROOT` to customize how the path of your source files are resolved.
Note that `-sourceroot` also sets the root path of the SemanticDB files.

## Details: how the code is instrumented

When the `-coverage-out` option is set, a new phase `instrumentCoverage` runs, just before `firstTransform`.
For a carefully selected list of tree types, it adds a call to `scala.runtime.Invoker.invoked(statementId, DIR)`.

For instance, this code:
```
def method() =
println(f())
```

with `-coverage-out:target/cov` be turned to
```
def method() =
Invoker.invoked(2, "target/cov")
println({
Invoker.invoked(1, "target/cov")
f()
})
```

At the end of the phase, the list of all the instrumented statements is serialized to the file `DIR/scoverage.coverage`.
61 changes: 0 additions & 61 deletions docs/_docs/usage/coverage.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -194,5 +194,6 @@ subsection:
- page: internals/dotty-internals-1-notes.md
- page: internals/debug-macros.md
- page: internals/gadts.md
- page: internals/coverage.md
- page: release-notes-0.1.2.md
hidden: true