From acb7f97eb82dfbbdb797354e1550b910055b4422 Mon Sep 17 00:00:00 2001
From: Marko Bencun <mbencun+pgp@gmail.com>
Date: Sun, 29 Dec 2019 21:52:01 +0100
Subject: [PATCH] README: add a section for test coverage

It is a hassle to figure out the exact commands to create a good
report.
---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index c18e43db5e364..434178b372839 100644
--- a/README.md
+++ b/README.md
@@ -77,6 +77,27 @@ With valgrind, you might need to increase the max stack size:
 
     $ valgrind --max-stackframe=2500000 ./exhaustive_tests
 
+Test coverage
+-----------
+
+This library aims to have full coverage of the reachable lines and branches.
+
+To create a test coverage report, configure with `--enable-coverage` (use of GCC is necessary):
+
+    $ ./configure --enable-coverage
+
+Run the tests:
+
+    $ make check
+
+To create a report, `gcovr` is recommended, as it includes branch coverage reporting:
+
+    $ gcovr --exclude 'src/bench*' --print-summary
+
+To create a HTML report with coloured and annotated source code:
+
+    $ gcovr --exclude 'src/bench*' --html --html-details -o coverage.html
+
 Reporting a vulnerability
 ------------