X-Git-Url: http://git.liburcu.org/?p=urcu.git;a=blobdiff_plain;f=README;h=ba9c16dbdd5f6dfb8f7b96ad719eafda11b8a02f;hp=0f92ac690f1ce884139b18557cea062e893abc80;hb=02be55611d3b1c7bf4fdfcb3a9c98f621882d417;hpb=7d413817f09b2d17b1a79ea012590609ffab5eb6

diff --git a/README b/README
index 0f92ac6..ba9c16d 100644
--- a/README
+++ b/README
@@ -10,21 +10,23 @@ BUILDING
 	make install
 
 	Hints:	Forcing 32-bit build:
-		* CFLAGS=-m32 ./configure
+		* CFLAGS="-m32 -g -O2" ./configure
 
 		Forcing 64-bit build:
-		* CFLAGS=-m64 ./configure
+		* CFLAGS="-m64 -g -O2" ./configure
 
-		Forcing a 32-bit build with down to 386 compatibility:
-		* CFLAGS=-m32 ./configure --target=i386-pc-linux-gnu
+		Forcing a 32-bit build with 386 backward compatibility:
+		* 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, 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 Sparcv9 32/64 are supported. Only tested on Linux so far, but should
+theoretically work on other operating systems.
 
 QUICK START GUIDE
 -----------------
@@ -44,15 +46,15 @@ Usage of liburcu
 	* Link the application with "-lurcu".
 	* This is the preferred version of the library, both in terms of speed
 	  and flexibility. Requires a signal, typically SIGUSR1. Can be
-	  overridden with -DSIGURCU by modifying Makefile.build.inc.
+	  overridden with -DSIGRCU by modifying Makefile.build.inc.
 
 Usage of liburcu-mb
 
 	* #include <urcu.h>
-	* Compile any _LGPL_SOURCE code using this library with "-DURCU_MB".
+	* Compile any _LGPL_SOURCE code using this library with "-DRCU_MB".
 	* Link with "-lurcu-mb".
 	* This version of the urcu library does not need to
-	  reserve a signal number. URCU_MB uses full memory barriers for
+	  reserve a signal number. RCU_MB uses full memory barriers for
 	  readers. This eliminates the need for signals but results in slower
 	  reads.
 
@@ -72,7 +74,7 @@ Usage of liburcu-bp
 	* Link with "-lurcu-bp".
 	* The BP library flavor stands for "bulletproof". It is specifically
 	  designed to help tracing library to hook on applications without
-	  requiring to modify these applications. urcu_init(),
+	  requiring to modify these applications. rcu_init(),
 	  rcu_register_thread() and rcu_unregister_thread() all become nops.
 	  The state is dealt with by the library internally at the expense of
 	  read-side and write-side performance.
@@ -100,11 +102,20 @@ Writing
 Usage of liburcu-defer
 
 	* #include <urcu-defer.h>
-	* Link with "-lurcu-defer"
-	* Provides call_rcu() primitive to enqueue delayed callbacks. Queued
+	* 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 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().
+	* Its API is currently experimental. It may change in future library
+	  releases.
 
 Being careful with signals