From ae05057c69a6ef9ed49b47db6e9ba2b8acdcfe23 Mon Sep 17 00:00:00 2001
From: Stef Walter <stefw@gnome.org>
Date: Thu, 7 Mar 2013 18:13:23 +0100
Subject: doc: Add P11_KIT_STRICT=yes debugging tip

---
 doc/p11-kit-devel.xml | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'doc')

diff --git a/doc/p11-kit-devel.xml b/doc/p11-kit-devel.xml
index cfacbf8..d9c1ade 100644
--- a/doc/p11-kit-devel.xml
+++ b/doc/p11-kit-devel.xml
@@ -261,6 +261,17 @@ $ make install
 
 		<para>Use the <literal>return_val_xxx()</literal> precondition macros to
 		check for unexpected conditions.</para>
+	</section>
+
+	<section id="devel-debugging">
+		<title>Debugging Tips</title>
+
+		<para>Unexpected conditions will produce critical warnings by p11-kit.
+		These are often failed internal preconditions, and usually indicate a
+		bug either in p11-kit or the software calling it.</para>
 
+		<para>You can use the environment variable <literal>P11_KIT_STRICT=yes</literal>
+		to make p11-kit do an <literal>abort()</literal> (and core dump depending on
+		your configuration) when a critical warning occurs.</para>
 	</section>
 </chapter>
-- 
cgit v1.1