[Coverage] Fix documentation and build error message
Fix documentation and build error message regarding
is_component_build flag.
Change-Id: I393ce3b376e30f4fbbabfea332b77728b5344d5a
Reviewed-on: https://chromium-review.googlesource.com/917223
Reviewed-by: Jonathan Metzman <[email protected]>
Reviewed-by: Abhishek Arya <[email protected]>
Commit-Queue: Abhishek Arya <[email protected]>
Cr-Commit-Position: refs/heads/master@{#537953}diff --git a/tools/code_coverage/coverage.py b/tools/code_coverage/coverage.py
index 98e4197..9aeac9b 100755
--- a/tools/code_coverage/coverage.py
+++ b/tools/code_coverage/coverage.py
@@ -8,13 +8,13 @@
https://clang.llvm.org/docs/SourceBasedCodeCoverage.html
In order to generate code coverage report, you need to first add
- "use_clang_coverage=true" GN flag to args.gn file in your build
- output directory (e.g. out/coverage).
+ "use_clang_coverage=true" and "is_component_build=false" GN flags to args.gn
+ file in your build output directory (e.g. out/coverage).
- It is recommended to add "is_component_build=false" flag as well because:
- 1. It is incompatible with other sanitizer flags (like "is_asan", "is_msan")
- and others like "optimize_for_fuzzing".
- 2. If it is not set explicitly, "is_debug" overrides it to true.
+ Clang Source-based Code Coverage requires "is_component_build=false" flag
+ because: There will be no coverage info for libraries in component builds and
+ "is_component_build" is set to true by "is_debug" unless it is explicitly set
+ to false.
Example usage:
