diff options
author | Jack Rosenthal <jrosenth@chromium.org> | 2021-11-04 12:11:58 -0600 |
---|---|---|
committer | Commit Bot <commit-bot@chromium.org> | 2021-11-05 04:22:34 +0000 |
commit | 252457d4b21f46889eebad61d4c0a65331919cec (patch) | |
tree | 01856c4d31d710b20e85a74c8d7b5836e35c3b98 /docs/code_coverage.md | |
parent | 08f5a1e6fc2c9467230444ac9b582dcf4d9f0068 (diff) | |
download | chrome-ec-stabilize-quickfix-14695.187.B-ish.tar.gz |
ish: Trim down the release branchstabilize-wristpin-14469.59.B-ishstabilize-voshyr-14637.B-ishstabilize-quickfix-14695.187.B-ishstabilize-quickfix-14695.124.B-ishstabilize-quickfix-14526.91.B-ishstabilize-14695.85.B-ishstabilize-14695.107.B-ishstabilize-14682.B-ishstabilize-14633.B-ishstabilize-14616.B-ishstabilize-14589.B-ishstabilize-14588.98.B-ishstabilize-14588.14.B-ishstabilize-14588.123.B-ishstabilize-14536.B-ishstabilize-14532.B-ishstabilize-14528.B-ishstabilize-14526.89.B-ishstabilize-14526.84.B-ishstabilize-14526.73.B-ishstabilize-14526.67.B-ishstabilize-14526.57.B-ishstabilize-14498.B-ishstabilize-14496.B-ishstabilize-14477.B-ishstabilize-14469.9.B-ishstabilize-14469.8.B-ishstabilize-14469.58.B-ishstabilize-14469.41.B-ishstabilize-14442.B-ishstabilize-14438.B-ishstabilize-14411.B-ishstabilize-14396.B-ishstabilize-14395.B-ishstabilize-14388.62.B-ishstabilize-14388.61.B-ishstabilize-14388.52.B-ishstabilize-14385.B-ishstabilize-14345.B-ishstabilize-14336.B-ishstabilize-14333.B-ishrelease-R99-14469.B-ishrelease-R98-14388.B-ishrelease-R102-14695.B-ishrelease-R101-14588.B-ishrelease-R100-14526.B-ishfirmware-cherry-14454.B-ishfirmware-brya-14505.B-ishfirmware-brya-14505.71.B-ishfactory-kukui-14374.B-ishfactory-guybrush-14600.B-ishfactory-cherry-14455.B-ishfactory-brya-14517.B-ish
In the interest of making long-term branch maintenance incur as little
technical debt on us as possible, we should not maintain any files on
the branch we are not actually using.
This has the added effect of making it extremely clear when merging CLs
from the main branch when changes have the possibility to affect us.
The follow-on CL adds a convenience script to actually pull updates from
the main branch and generate a CL for the update.
BUG=b:204206272
BRANCH=ish
TEST=make BOARD=arcada_ish && make BOARD=drallion_ish
Signed-off-by: Jack Rosenthal <jrosenth@chromium.org>
Change-Id: I17e4694c38219b5a0823e0a3e55a28d1348f4b18
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3262038
Reviewed-by: Jett Rink <jettrink@chromium.org>
Reviewed-by: Tom Hughes <tomhughes@chromium.org>
Diffstat (limited to 'docs/code_coverage.md')
-rw-r--r-- | docs/code_coverage.md | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/code_coverage.md b/docs/code_coverage.md deleted file mode 100644 index ec8053ca93..0000000000 --- a/docs/code_coverage.md +++ /dev/null @@ -1,50 +0,0 @@ -# Code Coverage - -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.) - -## Zephyr ztest code coverage - -To build the Zephyr unit tests for code coverage run: - -`zmake coverage build/ztest-coverage` - -This target will compile, without linking, all zephyr projects with -`CONFIG_COVERAGE` Kconfig option enabled, run the tests, and then process the -profiling data into a code coverage report using the `lcov` and `genhtml` -tools. This requires the `HAS_COVERAGE_SUPPORT` option, which can only be -selected in `Kconfig.board`. - -The coverage report top-level page is -`build/ztest-coverage/coverage_rpt/index.html`. |