From fc383e025f09af70d3eb52fcd7e03c02733b14b0 Mon Sep 17 00:00:00 2001
From: Stef Walter <stefw@gnome.org>
Date: Fri, 8 Mar 2013 10:04:11 +0100
Subject: Document and put code coverage online

 * Document our testing practices
 * Put lcov code coverage output online
---
 doc/p11-kit-devel.xml | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'doc')

diff --git a/doc/p11-kit-devel.xml b/doc/p11-kit-devel.xml
index af32c54..bbe6c0a 100644
--- a/doc/p11-kit-devel.xml
+++ b/doc/p11-kit-devel.xml
@@ -263,6 +263,28 @@ $ make install
 		check for unexpected conditions.</para>
 	</section>
 
+	<section id="devel-testing">
+		<title>Testing and Code Coverage</title>
+
+		<para>As a general rule changes to p11-kit should have a tests exercising
+		that change. Use the <literal>make check</literal> command to run all
+		the tests. If you run it from a subdirectory only the tests in that
+		directory will be run.</para>
+
+		<para>Build p11-kit with the <option>--enable-coverage</option> configure
+		option to build code coverage support.</para>
+
+		<para>Once you've done that you can either use <literal>make coverage</literal>
+		to build code coverage information. Alternatively (and this is usually
+		easier) you can use
+		<ulink url="http://stef.thewalter.net/2012/12/git-coverage-useful-code-coverage.html">
+			<literal>git coverage</literal></ulink> to easily check whether
+		you've tested the lines changed by a patch.</para>
+
+		<para>A code coverage report is
+			<ulink url="http://p11-glue.freedesktop.org/build/coverage">available online</ulink></para>.
+	</section>
+
 	<section id="devel-debugging">
 		<title>Debugging Tips</title>
 
-- 
cgit v1.1