commit: r1621 - neon/trunk/doc/ref

[joe at manyfish.co.uk]

Author: joe
Date: Wed Jan 28 17:06:30 2009
New Revision: 1621

Modified:
   neon/trunk/doc/ref/neon.xml

Log:
* doc/ref/neon.xml: Add note on lack of async-signal-safety, and
fix a typo.


Modified: neon/trunk/doc/ref/neon.xml
==============================================================================
--- neon/trunk/doc/ref/neon.xml	(original)
+++ neon/trunk/doc/ref/neon.xml	Wed Jan 28 17:06:30 2009
@@ -59,7 +59,7 @@
       otherwise handled to avoid process termination when writing to a
       socket which has been shutdown by the peer.</simpara></listitem>
 
-      <listitem><simpara>OpenSSL and GnuTLSrequire global
+      <listitem><simpara>OpenSSL and GnuTLS require global
       initialization to load shared lookup
       tables.</simpara></listitem>
 
@@ -82,9 +82,19 @@
   </refsect2>
 
   <refsect2>
+    <title>Asynchronous signal safety</title>
+    
+    <para>No function in &neon; is defined to be <quote>async-signal safe</quote> -
+    that is, no function is safe to call from a signal handler.  Any
+    call into the &neon; library from a signal handler will have
+    undefined behaviour - in other words, it may crash the
+    process.</para>
+  </refsect2>
+
+  <refsect2>
     <title>Functions using global state</title>
 
-    <para>Any function call in &neon; may modify the
+    <para>Any function in &neon; may modify the
     <literal>errno</literal> global variable as a side-effect.  Except
     where explicitly documented, the value of <literal>errno</literal>
     is unspecified after any &neon; function call.</para>