Skip to content

Commit

Permalink
Mention that code coverage can change from release to release
Browse files Browse the repository at this point in the history
As noted in the `-C instrument coverage` documentation itself, the exact
format of instrumentation that rustc uses will vary from release to
release as LLVM makes changes to it and it is also expected that code
coverage data or metrics may change slightly from one release to another
due to changes in how rustc generates code, how LLVM interprets coverage
data and how we improve the coverage feature.
  • Loading branch information
wesleywiser committed Dec 19, 2024
1 parent 9f41bc1 commit d0ff99c
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/attributes/coverage-instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
The following [attributes] are used for controlling coverage instrumentation.

> **Note**: Coverage instrumentation is controlled in `rustc` with the [`-C instrument-coverage`] compiler flag.
Exact specifics of how code coverage works or what code is reported in code coverage data may change from release to release.

[`-C instrument-coverage`]: ../../rustc/instrument-coverage.html

Expand Down

0 comments on commit d0ff99c

Please sign in to comment.