Document rcu_register_thread in README
authorMathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
Sat, 16 May 2009 21:25:18 +0000 (17:25 -0400)
committerMathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
Sat, 16 May 2009 21:25:18 +0000 (17:25 -0400)
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
README

diff --git a/README b/README
index d47e5df9465070010a15797671ed48195dcf0628..c571af521d69307be1ac701e3c5366953b30553d 100644 (file)
--- 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
This page took 0.024672 seconds and 4 git commands to generate.