Document urcu-defer usage with dlclose()

[urcu.git] / README

diff --git a/README b/README
index fce568089b3182aada2a802939512cb99aa280b5..72e73de93f0244cb232f5c4dc7102c4c567db965 100644 (file)
--- a/README
+++ b/README
@@ -21,10 +21,9 @@ BUILDING
 ARCHITECTURES SUPPORTED
 -----------------------
 
-Currently, x86 (i386, i486, i586, i686), x86 64, PowerPC 32/64 and S390 are
-supported. The current use of sys_futex() makes it Linux-dependent, although
-this portability limitation might go away in a near future by using the pthread
-cond vars.
+Currently, x86 (i386, i486, i586, i686), x86 64-bit, PowerPC 32/64, S390, S390x
+and Sparc64 are supported. Only tested on Linux so far, but should
+theoretically work on other operating systems.
 
 QUICK START GUIDE
 -----------------
@@ -101,10 +100,16 @@ Usage of liburcu-defer
 
        * #include <urcu-defer.h>
        * Link with "-lurcu-defer"
-       * Provides call_rcu() primitive to enqueue delayed callbacks. Queued
+       * Provides defer_rcu() primitive to enqueue delayed callbacks. Queued
          callbacks are executed in batch periodically after a grace period.
-         Do _not_ use call_rcu() within a read-side critical section, because
+         Do _not_ use defer_rcu() within a read-side critical section, because
          it may call synchronize_rcu() if the thread queue is full.
+       * Provides defer_rcu_ratelimit() primitive, which acts just like
+         defer_rcu(), but takes an additional rate limiter callback forcing
+         synchronized callback execution of the limiter returns non-zero.
+       * Requires that rcu_defer_barrier() must be called in library destructor
+         if a library queues callbacks and is expected to be unloaded with
+         dlclose().
 
 Being careful with signals