X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=README;h=ba9c16dbdd5f6dfb8f7b96ad719eafda11b8a02f;hb=9d7e3f89772f08cca26d727f47d44ecd47c94401;hp=e1ce893737acd0d4d79260462f6383ff45a05c42;hpb=ec8e44cf2ba50dcb421af40b67e74650bb5057f6;p=urcu.git

diff --git a/README b/README
index e1ce893..ba9c16d 100644
--- 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
@@ -43,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.
 
@@ -71,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.
@@ -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