X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;ds=sidebyside;f=README;h=9d154c53832d471871f99ca0e4dc1ae5ec74109f;hb=1eade46a854eb8211be9fd32e0cf6835576deb63;hp=33038af3ab12c0cc96aacbedf3cf6e76ea2fd5f7;hpb=aac98a5504a989c227bb9290f2849abc9458811c;p=urcu.git

diff --git a/README b/README
index 33038af..9d154c5 100644
--- a/README
+++ b/README
@@ -17,11 +17,12 @@ BUILDING
 		* CFLAGS="-m64 -g -O2" ./configure
 
 		Forcing a 32-bit build with 386 backward compatibility:
-		* CFLAGS="-m32 -g -O2" ./configure --host=i386-pc-linux-gnu
+		* CFLAGS="-m32 -g -O2" ./configure --target=i386-pc-linux-gnu
 
 		Forcing a 32-bit build for Sparcv9 (typical for Sparc v9)
 		* CFLAGS="-m32 -Wa,-Av9a -g -O2" ./configure
 
+
 ARCHITECTURES SUPPORTED
 -----------------------
 
@@ -66,6 +67,19 @@ Test scripts provided in the tests/ directory of the source tree depend
 on "bash" and the "seq" program.
 
 
+API
+---
+
+See the relevant API documentation files in doc/. The APIs provided by
+Userspace RCU are, by prefix:
+
+- rcu_ : Read-Copy Update
+- cmm_ : Concurrent Memory Model
+- caa_ : Concurrent Architecture Abstraction
+- cds_ : Concurrent Data Structures
+- uatomic_: Userspace Atomic
+
+
 QUICK START GUIDE
 -----------------
 
@@ -189,11 +203,12 @@ Being careful with signals
 	signal(7). The liburcu-mb and liburcu-qsbr versions of the Userspace RCU
 	library do not require any signal.
 
-	Read-side critical sections are allowed in a signal handler with
-	liburcu and liburcu-mb. Be careful, however, to disable these signals
+	Read-side critical sections are allowed in a signal handler,
+	except those setup with sigaltstack(2), with liburcu and
+	liburcu-mb. Be careful, however, to disable these signals
 	between thread creation and calls to rcu_register_thread(), because a
-	signal handler nesting on an unregistered thread would not be allowed to
-	call rcu_read_lock().
+	signal handler nesting on an unregistered thread would not be
+	allowed to call rcu_read_lock().
 
 	Read-side critical sections are _not_ allowed in a signal handler with
 	liburcu-qsbr, unless signals are disabled explicitly around each