From: Martin Mares <mj@ucw.cz>
Date: Wed, 20 Sep 2006 14:35:12 +0000 (+0200)
Subject: Documented thread safety of ucwlib functions.
X-Git-Tag: holmes-import~512^2~2
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=7b088210cb4bf6e26fee4d05cc3d80cda2d2cd95;p=libucw.git

Documented thread safety of ucwlib functions.
---

diff --git a/lib/THREADS b/lib/THREADS
new file mode 100644
index 00000000..1cb77b65
--- /dev/null
+++ b/lib/THREADS
@@ -0,0 +1,10 @@
+Generally, functions in the UCW library are reentrant as long as you call them
+on different data. Calling on the same object is not, unless otherwise told,
+which also includes functions acting on any kind of global state.
+
+There are some exceptions:
+
+- logging functions are safe as long as you don't switch log files
+- setproctitle() is not safe, it modifies global state
+- handle_signal() is not safe, it modifies global state
+- stk_printf() is not safe, it currently uses a global buffer (FIXME!)