diff options
| author | Sean Abraham <seanabraham@chromium.org> | 2021-03-01 15:13:48 -0700 |
|---|---|---|
| committer | Sean Abraham <seanabraham@chromium.org> | 2021-03-01 22:59:54 +0000 |
| commit | 1e800ac838504c0d2950c7aa90cdfe7bde251545 (patch) | |
| tree | 64706ca3d77a1452ac653d40fb71e6ae9d6a34bc /docs/code_coverage.md | |
| parent | ef6a915de0a2b65c18c03074b66717d597675162 (diff) | |
| download | chrome-ec-master.tar.gz | |
docs: point md files in master to main/HEADmaster
Master md files are out of date. Point to main branch in case someone
lands in master branch from an old link.
BUG=b:180952272,b:180921286
BRANCH=None
TEST=Preview changes with gerrit
Exempt-From-Owner-Approval: fixing docs
Change-Id: I6583b6c7fc21248eb49a6cd71e077fbdb5de2435
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2727846
Reviewed-by: Sean Abraham <seanabraham@chromium.org>
Reviewed-by: Rob Barnes <robbarnes@google.com>
Auto-Submit: Sean Abraham <seanabraham@chromium.org>
Tested-by: Sean Abraham <seanabraham@chromium.org>
Diffstat (limited to 'docs/code_coverage.md')
| -rw-r--r-- | docs/code_coverage.md | 37 |
1 files changed, 4 insertions, 33 deletions
diff --git a/docs/code_coverage.md b/docs/code_coverage.md index 458d87b7c5..c0ebef69f0 100644 --- a/docs/code_coverage.md +++ b/docs/code_coverage.md @@ -1,34 +1,5 @@ -# Code Coverage +*** note +**Warning: This document is old & has moved. Please update any links:**<br> +https://chromium.googlesource.com/chromiumos/platform/ec/+/HEAD/docs/code_coverage.md +*** -Provides an overview of how to use code coverage tools when running the unit -tests in the EC codebase. - -[TOC] - -## Availability - -Code coverage is only available for host-based unit tests, as opposed to -manual tests that run on target hardware. - -## Building for code coverage - -To build host-based unit tests for code coverage, invoke `make` with the -`coverage` target, as follows: - -`make coverage -j` - -This target will compile and link the unit tests with `--coverage` flag (which -pulls in the `gcov` libraries), run the tests, and then process the profiling -data into a code coverage report using the `lcov` and `genhtml` tools. - -The coverage report top-level page is `build/coverage/coverage_rpt/index.html`. - -### Noise in the build output - -When building for code coverage, you may see multiple warnings of the form -`geninfo: WARNING: no data found for /mnt/host/source/src/platform/ec/core/host/cpu.h` -and -`genhtml: WARNING: function data mismatch at /mnt/host/source/src/platform/ec/common/math_util.c:134` - -These warnings can be ignored. (FYI, the "function data mismatch" warnings -appear to be caused in part by using relative paths instead of absolute paths.) |