doc: Add P11_KIT_STRICT=yes debugging tip

diff --git a/doc/p11-kit-devel.xml b/doc/p11-kit-devel.xml
index cfacbf84d0fd1916b107a3c13e17662af6555ece..d9c1ade62f96c75d22da64505bf9f9bc6de2f5ba 100644 (file)
--- 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>