summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Documentation/technotes/2021-05-code-coverage.md3
1 files changed, 3 insertions, 0 deletions
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`.