summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKeith Packard <keithp@keithp.com>2013-11-25 13:36:54 -0800
committerKeith Packard <keithp@keithp.com>2013-11-25 13:36:54 -0800
commit4b7c89d0dcaf48140c190dfe6a4560960229ab44 (patch)
tree8e5337d772d6e84c8a181e0903c5207bb70ccddc
parentc43c79c34d26277609fa02aedc1b862f4a280808 (diff)
downloadxorg-lib-libxshmfence-4b7c89d0dcaf48140c190dfe6a4560960229ab44.tar.gz
Describe the library better in the README file
Signed-off-by: Keith Packard <keithp@keithp.com>
-rw-r--r--README13
1 files changed, 12 insertions, 1 deletions
diff --git a/README b/README
index 66b36f0..db193b7 100644
--- a/README
+++ b/README
@@ -1,4 +1,15 @@
-libxshmfence - Direct Rendering Infrastructure 3 Extension
+libxshmfence - Shared memory 'SyncFence' synchronization primitive
+
+This library offers a CPU-based synchronization primitive compatible
+with the X SyncFence objects that can be shared between processes
+using file descriptor passing.
+
+There are two underlying implementations:
+
+ 1) On Linux, the library uses futexes
+
+ 2) On other systems, the library uses posix mutexes and condition
+ variables.
All questions regarding this software should be directed at the
Xorg mailing list: