X-Git-Url: https://git.liburcu.org/?p=urcu.git;a=blobdiff_plain;f=README;h=71eec3530465ebe2093093dce57b4871b0facd66;hp=96389add129001f9e67a15f63ed8368b37f02cc7;hb=cdc45d639bb6c2e6e35fef529b4e9ad9ae83b2b5;hpb=256dd999d11736ebe5ad2865219879199c89cc90

diff --git a/README b/README
index 96389ad..71eec35 100644
--- a/README
+++ b/README
@@ -4,9 +4,16 @@ by Mathieu Desnoyers and Paul E. McKenney
 BUILDING
 --------
 
+	./bootstrap (skip if using tarball)
+	./configure
 	make
 	make install
-	
+
+	Note:	Forcing 32-bit build:
+		* CFLAGS=-m32 ./configure
+
+		Forcing 64-bit build:
+		* CFLAGS=-m64 ./configure
 
 QUICK START GUIDE
 -----------------
@@ -48,6 +55,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
@@ -68,6 +86,15 @@ Writing
 	After, synchronize_rcu() must be called. When it returns, the old
 	values are not in usage anymore.
 
+Usage of liburcu-defer
+
+	* #include <urcu-defer.h>
+	* Link with "-lurcu-defer"
+	* Provides call_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
+	  it may call synchronize_rcu() if the thread queue is full.
+
 Being careful with signals
 
 	The liburcu library uses signals internally. The signal handler is