Cleanup the debug code.
[npth.git] / README
1              nPth - The New GNU Portable Threads Library
2
3 * Overview
4
5   This is a library to provide the GNU Pth API and thus a
6   non-preemptive threads implementation.
7
8   In contrast to GNU Pth is is based on the system's standard threads
9   implementation.  This allows the use of libraries which are not
10   compatible to GNU Pth.  Experience with a Windows Pth emulation
11   showed that this is a solid way to provide a co-routine based
12   framework.
13
14   See the file AUTHORS for contact and copyright information.
15
16 * License
17
18   nPth is currently released under a mixed LGPLv3+/GPLv2+ license.
19   This is to allow its use with GPLv2(only) software.  If there is a
20   need for other licensing terms, please contact us.
21
22 * Porting hints
23
24   Documentation is currently missing.  If you are using GNU Pth you
25   should be able to understand the API.  Given that GNU Pth is rarely
26   used, we hestitate to spend work on a migration guide.  If you have
27   questions, please ask on gnupg-devel.  Here are some hints:
28
29   - Pth mutexes are recursive, that is they will not block if called
30     by the same thread.  In contrast, nPth mutexes are not recursive;
31     it is best to change your code to avoid recursive use of mutexes.
32     nPth uses non-recursive mutexes for performance reasons.