X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=README;h=ecdda633e20fe3f6fa772a90644b99b2f302ea3b;hb=632dd6bae1cb2b590185c2bdad12e9531409aa53;hp=e5c04b179cae49d202a49809d09a76f714ada711;hpb=ec4e58a3aba2084440012f8ccac3a31eb6101183;p=urcu.git

diff --git a/README b/README
index e5c04b1..ecdda63 100644
--- a/README
+++ b/README
@@ -4,11 +4,26 @@ by Mathieu Desnoyers and Paul E. McKenney
 BUILDING
 --------
 
+	./bootstrap (skip if using tarball)
+	./configure
 	make
-	#force 32-bit build with: make -f Makefile32
-	#force 64-bit build with: make -f Makefile64
 	make install
-	
+
+	Hints:	Forcing 32-bit build:
+		* CFLAGS="-m32 -g -O2" ./configure
+
+		Forcing 64-bit build:
+		* CFLAGS="-m64 -g -O2" ./configure
+
+		Forcing a 32-bit build with 386 backward compatibility:
+		* CFLAGS="-m32 -g -O2" ./configure --target=i386-pc-linux-gnu
+
+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
+theoretically work on other operating systems.
 
 QUICK START GUIDE
 -----------------
@@ -50,6 +65,17 @@ Usage of liburcu-qsbr
 	  the threads are not active. It provides the fastest read-side at the
 	  expense of more intrusiveness in the application code.
 
+Usage of liburcu-bp
+
+	* #include <urcu-bp.h>
+	* 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(),
+	  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.
+
 Initialization
 
 	Each thread that has reader critical sections (that uses
@@ -74,9 +100,9 @@ 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.
 
 Being careful with signals
@@ -111,3 +137,13 @@ Usage of DEBUG_YIELD
 
 	DEBUG_YIELD is used to add random delays in the code for testing
 	purposes.
+
+SMP support
+
+	By default the library is configured to use synchronization primitives
+	adequate for SMP systems. On uniprocessor systems, support for SMP
+	systems can be disabled with:
+
+		./configure --disable-smp-support
+
+	theoretically yielding slightly better performance.