Skip to content

Commit f58a362

Browse files
committed
Update coverage docs and command line help
1 parent 603a42e commit f58a362

File tree

4 files changed

+131
-82
lines changed

4 files changed

+131
-82
lines changed

compiler/rustc_codegen_llvm/src/coverageinfo/mapgen.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ fn save_function_record(
249249
///
250250
/// We can find the unused functions (including generic functions) by the set difference of all MIR
251251
/// `DefId`s (`tcx` query `mir_keys`) minus the codegenned `DefId`s (`tcx` query
252-
/// `collect_and_partition_mono_items`).
252+
/// `codegened_and_inlined_items`).
253253
///
254254
/// *HOWEVER* the codegenned `DefId`s are partitioned across multiple `CodegenUnit`s (CGUs), and
255255
/// this function is processing a `function_coverage_map` for the functions (`Instance`/`DefId`)

compiler/rustc_session/src/options.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -1056,12 +1056,12 @@ options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
10561056
"gather statistics about the input (default: no)"),
10571057
instrument_coverage: Option<InstrumentCoverage> = (None, parse_instrument_coverage, [TRACKED],
10581058
"instrument the generated code to support LLVM source-based code coverage \
1059-
reports (note, the compiler build config must include `profiler = true`, \
1060-
and is mutually exclusive with `-C profile-generate`/`-C profile-use`); \
1061-
implies `-Z symbol-mangling-version=v0`; disables/overrides some Rust \
1062-
optimizations. Optional values are: `=all` (default coverage), \
1063-
`=except-unused-generics`, `=except-unused-functions`, or `=off` \
1064-
(default: instrument-coverage=off)"),
1059+
reports (note, the compiler build config must include `profiler = true`); \
1060+
implies `-Z symbol-mangling-version=v0`. Optional values are:
1061+
`=all` (implicit value)
1062+
`=except-unused-generics`
1063+
`=except-unused-functions`
1064+
`=off` (default)"),
10651065
instrument_mcount: bool = (false, parse_bool, [TRACKED],
10661066
"insert function instrument code for mcount-based tracing (default: no)"),
10671067
keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],

0 commit comments

Comments
 (0)