From: Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
Date: Sat, 16 May 2009 21:25:18 +0000 (-0400)
Subject: Document rcu_register_thread in README
X-Git-Tag: v0.1~220
X-Git-Url: http://git.lttng.org/?p=userspace-rcu.git;a=commitdiff_plain;h=aa8c36e03126a731c6c925cb32a8649c9802198d

Document rcu_register_thread in README

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
---

diff --git a/README b/README
index d47e5df..c571af5 100644
--- a/README
+++ b/README
@@ -7,5 +7,12 @@ make pthreads-ppc
 make
 make install
 
+Usage :
+
+Registration of _each thread_ calling read-side critical sections must be done
+with rcu_register_thread() before using rcu_read_lock()/rcu_read_unlock().
+
+Unregistration should be performed with rcu_unregister_thread() before exiting
+the thread.
 
      Mathieu Desnoyers