version 0.3.4

[urcu.git] / README

diff --git a/README b/README
index e1ce893737acd0d4d79260462f6383ff45a05c42..ca23d43fe3bee6b5e62d5cfcd0489bb93c7ffc2b 100644 (file)
--- a/README
+++ b/README
@@ -16,13 +16,16 @@ BUILDING
                * CFLAGS="-m64 -g -O2" ./configure
 
                Forcing a 32-bit build with 386 backward compatibility:
-               * CFLAGS="-m32 -g -O2" ./configure --target=i386-pc-linux-gnu
+               * CFLAGS="-m32 -g -O2" ./configure --host=i386-pc-linux-gnu
+
+               Forcing a 32-bit build for Sparcv9 (typical for Sparc v9)
+               * CFLAGS="-m32 -Wa,-Av9a -g -O2" ./configure
 
 ARCHITECTURES SUPPORTED
 -----------------------
 
 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
+and Sparcv9 32/64 are supported. Only tested on Linux so far, but should
 theoretically work on other operating systems.
 
 QUICK START GUIDE
@@ -99,7 +102,8 @@ Writing
 Usage of liburcu-defer
 
        * #include <urcu-defer.h>
-       * Link with "-lurcu-defer"
+       * Link with "-lurcu-defer", and also with one of the urcu library
+         (either urcu, urcu-bp, urcu-mb or urcu-qsbr).
        * Provides defer_rcu() primitive to enqueue delayed callbacks. Queued
          callbacks are executed in batch periodically after a grace period.
          Do _not_ use defer_rcu() within a read-side critical section, because
@@ -107,6 +111,11 @@ Usage of liburcu-defer
        * 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().
+       * Its API is currently experimental. It may change in future library
+         releases.
 
 Being careful with signals