diff options
| author | Rich Kadel <richkadel@google.com> | 2020-12-01 23:01:26 -0800 |
|---|---|---|
| committer | Rich Kadel <richkadel@google.com> | 2020-12-03 09:50:10 -0800 |
| commit | d96f351fa36d31f2b95b1cd2ad37ceaed3d395a8 (patch) | |
| tree | b51e88d4b3163850b652ea044962b812bb339b38 /src/doc | |
| parent | def932ca865b86a5057517d8a0e27c0ca72a0815 (diff) | |
| download | rust-d96f351fa36d31f2b95b1cd2ad37ceaed3d395a8.tar.gz rust-d96f351fa36d31f2b95b1cd2ad37ceaed3d395a8.zip | |
Addressed feedback from 2020-12-01
Added one more test (two files) showing coverage of generics and unused functions across crates. Created and referenced new Issues, as requested. Added comments. Added a note about the possible effects of compiler options on LLVM coverage maps.
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/unstable-book/src/compiler-flags/source-based-code-coverage.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/doc/unstable-book/src/compiler-flags/source-based-code-coverage.md b/src/doc/unstable-book/src/compiler-flags/source-based-code-coverage.md index 95c2450ae57..9930bc67cd5 100644 --- a/src/doc/unstable-book/src/compiler-flags/source-based-code-coverage.md +++ b/src/doc/unstable-book/src/compiler-flags/source-based-code-coverage.md @@ -76,6 +76,8 @@ $ RUSTC=$HOME/rust/build/x86_64-unknown-linux-gnu/stage1/bin/rustc \ cargo build --example formatjson5 ``` +Note that some compiler options, combined with `-Zinstrument-coverage`, can produce LLVM IR and/or linked binaries that are incompatible with LLVM coverage maps. For example, coverage requires references to actual functions in LLVM IR. If any covered function is optimized out, the coverage tools may not be able to process the coverage results. If you need to pass additional options, with coverage enabled, test them early, to confirm you will get the coverage results you expect. + ## Running the instrumented binary to generate raw coverage profiling data In the previous example, `cargo` generated the coverage-instrumented binary `formatjson5`: |