summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStef Walter <stefw@gnome.org>2013-03-07 18:13:23 +0100
committerStef Walter <stefw@gnome.org>2013-03-07 18:13:23 +0100
commitae05057c69a6ef9ed49b47db6e9ba2b8acdcfe23 (patch)
treeba594e129b1ddc6a4c6450e4bbcd08543e73c6df
parent220d7b027871f79f446c7b3c2db9ef43f24c19cc (diff)
downloadp11-kit-ae05057c69a6ef9ed49b47db6e9ba2b8acdcfe23.tar.gz
doc: Add P11_KIT_STRICT=yes debugging tip
-rw-r--r--doc/p11-kit-devel.xml11
1 files changed, 11 insertions, 0 deletions
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>