diff options
| author | joe <joe@61a7d7f5-40b7-0310-9c16-bb0ea8cb1845> | 2009-01-29 01:06:30 +0000 |
|---|---|---|
| committer | joe <joe@61a7d7f5-40b7-0310-9c16-bb0ea8cb1845> | 2009-01-29 01:06:30 +0000 |
| commit | 723b10c247d84ae69bbc1e15a287b8ee684a5a9e (patch) | |
| tree | ab76c8da3d45d63ecb46cf39f05ff6b60b3cd79d /doc | |
| parent | d7ecf1bd26fb7ac067802b46ab4408dffd44d648 (diff) | |
| download | neon-723b10c247d84ae69bbc1e15a287b8ee684a5a9e.tar.gz | |
* doc/ref/neon.xml: Add note on lack of async-signal-safety, and
fix a typo.
git-svn-id: http://svn.webdav.org/repos/projects/neon/trunk@1621 61a7d7f5-40b7-0310-9c16-bb0ea8cb1845
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ref/neon.xml | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/ref/neon.xml b/doc/ref/neon.xml index 0c2a626..49bbc40 100644 --- a/doc/ref/neon.xml +++ b/doc/ref/neon.xml @@ -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> |