X-Git-Url: https://git.lttng.org/?p=urcu.git;a=blobdiff_plain;f=README;h=f9437dba2857856b726cc4539b6deeafaf09f668;hp=e5c04b179cae49d202a49809d09a76f714ada711;hb=64c4cafd597aff7423be003dcf41735904126f66;hpb=ec4e58a3aba2084440012f8ccac3a31eb6101183

diff --git a/README b/README
index e5c04b1..f9437db 100644
--- a/README
+++ b/README
@@ -4,11 +4,25 @@ 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
-	
+
+	Note:	Forcing 32-bit build:
+		* CFLAGS=-m32 ./configure
+
+		Forcing 64-bit build:
+		* CFLAGS=-m64 ./configure
+
+ARCHITECTURES SUPPORTED
+-----------------------
+
+Currently, x86 (only P6+), 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. Also, the restriction against i386, i486 and Pentium might go away if
+we integrate some of glibc runtime CPU-detection tests.
 
 QUICK START GUIDE
 -----------------
@@ -50,6 +64,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