From: Tony Crisci <tony@dubstepdish.com>
Date: Wed, 1 Apr 2015 22:19:18 +0000 (-0400)
Subject: Document test coverage reporting for testcases
X-Git-Tag: 4.11~147^2
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=refs%2Fpull%2F1628%2Fhead;p=i3%2Fi3

Document test coverage reporting for testcases
---

diff --git a/docs/testsuite b/docs/testsuite
index 29a35218..8fdb9635 100644
--- a/docs/testsuite
+++ b/docs/testsuite
@@ -160,6 +160,27 @@ $ ./complete-run.pl --parallel=1 --keep-xserver-output
 This will show the output of Xephyr, which is the X server implementation we
 use for testing.
 
+==== Coverage testing
+
+Coverage testing is possible with +lcov+, the front-end for GCC's coverage
+testing tool +gcov+. The testcases can generate a nice html report that tells
+you which functions and lines were covered during a run of the tests. You can
+use this tool to judge how effective your tests are.
+
+To use test coverage tools, first compile with coverage enabled.
+
+---------------------------------------------------
+COVERAGE=1 make
+---------------------------------------------------
+
+Then run the tests with the +--coverage-testing+ flag.
+
+---------------------------------------------------
+./complete-run.pl --coverage-testing
+---------------------------------------------------
+
+Then open +latest/i3-coverage/index.html+ in your web browser.
+
 ==== IPC interface
 
 The testsuite makes extensive use of the IPC (Inter-Process Communication)