From aae5cdf1aaf0916695eb1a345941671ddb21901c Mon Sep 17 00:00:00 2001 From: Paul Fagerburg Date: Tue, 26 Oct 2021 13:20:25 -0600 Subject: Documenation: call out `lcov` as required Code coverage requires `lcov`, so update the docs to call it out specifically. Signed-off-by: Paul Fagerburg Change-Id: Ie2898faa5188a7174c4e56ba34f1a4f02f939b03 Reviewed-on: https://review.coreboot.org/c/coreboot/+/58633 Tested-by: build bot (Jenkins) Reviewed-by: Martin Roth --- Documentation/technotes/2021-05-code-coverage.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Documentation/technotes/2021-05-code-coverage.md b/Documentation/technotes/2021-05-code-coverage.md index ec7f4cb5f9..d33fe5d700 100644 --- a/Documentation/technotes/2021-05-code-coverage.md +++ b/Documentation/technotes/2021-05-code-coverage.md @@ -4,6 +4,9 @@ Code coverage for the coreboot unit tests allows us to see what lines of code in the coreboot library are covered by unit tests, and allows a test author to see where they need to add test cases for additional coverage. +Code coverage requires `lcov`; install the tool if necessary by +`sudo apt install lcov` or the equivalent for your system. + Enable code coverage in your unit test build by setting the environment variable `COV` to 1; either `export COV=1` in your shell, or add it to your `make` command, e.g. `COV=1 make unit-tests`. -- cgit v1.2.3