From d0ff99c3ddbd25510f03fdfbdcf09ea1e3a6e362 Mon Sep 17 00:00:00 2001 From: Wesley Wiser Date: Thu, 19 Dec 2024 13:13:50 -0600 Subject: [PATCH] Mention that code coverage can change from release to release 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. --- src/attributes/coverage-instrumentation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/attributes/coverage-instrumentation.md b/src/attributes/coverage-instrumentation.md index 8fbec0fbe..d0bd07952 100644 --- a/src/attributes/coverage-instrumentation.md +++ b/src/attributes/coverage-instrumentation.md @@ -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