From: Cole Robinson <crobinso@redhat.com>
Date: Wed, 13 Mar 2019 17:03:15 +0000 (-0400)
Subject: docs: hacking: Add 'Code coverage reports' section
X-Git-Tag: v5.2.0-rc1~186
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=47cbc929870aaff6b01ba24cd028b8787a1ae9a4;p=thirdparty%2Flibvirt.git

docs: hacking: Add 'Code coverage reports' section

Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
Signed-off-by: Cole Robinson <crobinso@redhat.com>
---

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index f99d143b7b..902d05430f 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1412,5 +1412,34 @@ int foo()
         in the same way, but still make sure they get reviewed if non-trivial.
       </li>
     </ul>
+    <h2><a id="coverage">Code coverage reports</a></h2>
+
+    <p>
+      Code coverage HTML reports can be generated with:
+    </p>
+
+<pre>
+  make coverage
+</pre>
+
+    <p>
+      Reports will be generated in the <code>cov/</code> directory. Point a
+      web browser at <code>cov/index.html</code> for the full report.
+    </p>
+
+    <p>
+      The <code>make coverage</code> target is provided by <code>gnulib</code>.
+      It is a convenience helper for calling the following 3 targets in order.
+      It may be useful to occasionally call these directly.
+
+    <ul>
+      <li><code>make init-coverage</code>: run <code>make clean</code> and
+          remove all code coverage counter files (*.gcno, etc.)</li>
+      <li><code>make build-coverage</code>: run <code>make</code> and
+          <code>make check</code> with <code>CFLAGS</code> filled in with
+          necessary coverage flags</li>
+      <li><code>make gen-coverage</code>: generate the HTML report</li>
+    </ul>
+    </p>
   </body>
 </html>