From: Martin Mares <mj@ucw.cz>
Date: Sat, 11 Feb 2012 17:53:02 +0000 (+0100)
Subject: Doc: Describe general rules for reentrancy
X-Git-Tag: v5.0~70
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=a9c4be342e6e5af67e20d219cffd0ab35bd6d9d6;p=libucw.git

Doc: Describe general rules for reentrancy
---

diff --git a/ucw/THREADS b/ucw/THREADS
deleted file mode 100644
index ec58d49a..00000000
--- a/ucw/THREADS
+++ /dev/null
@@ -1,7 +0,0 @@
-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:
-
-- setproctitle() is not safe, it modifies global state
diff --git a/ucw/doc/basics.txt b/ucw/doc/basics.txt
index 42f00977..8cc5414f 100644
--- a/ucw/doc/basics.txt
+++ b/ucw/doc/basics.txt
@@ -19,6 +19,12 @@ on Darwin, too. The authors did not try using it on other systems, but most of
 the code is written for a generic POSIX system, so porting to any UNIX-like system
 should be a piece of cake.
 
+Threads
+-------
+Generally, functions in the UCW library are reentrant as long as you call them
+on different data. Accessing the same object from different threads is not supported,
+unless otherwise told. This also applies to functions acting on any kind of global state.
+
 ucw/lib.h
 ---------
 *Only partially documented.*