summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Triplett <josh@freedesktop.org>2006-11-23 07:50:57 -0800
committerJosh Triplett <josh@freedesktop.org>2006-11-23 07:50:57 -0800
commit915145a94c523fb758215b05e3f297c71627e67b (patch)
treef04431d320bc57d9e12165cde3f7af187be325b7
parent00c8863385be5ca0787c61b648c3a7c8d26faddb (diff)
Add README
-rw-r--r--README9
1 files changed, 9 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..4e7e85b
--- /dev/null
+++ b/README
@@ -0,0 +1,9 @@
+This library provides weak aliases for pthread functions not provided in libc
+or otherwise available by default. Libraries like libxcb rely on pthread
+stubs to use pthreads optionally, becoming thread-safe when linked to
+libpthread, while avoiding any performance hit when running single-threaded.
+libpthread-stubs supports this behavior even on platforms which do not supply
+all the necessary pthread stubs. On platforms which already supply all the
+necessary pthread stubs, this package ships only the pkg-config file
+pthread-stubs.pc, to allow libraries to unconditionally express a dependency
+on pthread-stubs and still obtain correct behavior.