Update readme

[userspace-rcu.git] / README

diff --git a/README b/README
index e1ce893737acd0d4d79260462f6383ff45a05c42..883b808a3bed372f1dd2597e3e983b9f6c73eae2 100644 (file)
--- a/README
+++ b/README
@@ -16,7 +16,7 @@ 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
 
 ARCHITECTURES SUPPORTED
 -----------------------
@@ -99,7 +99,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 +108,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