From: Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
Date: Sat, 16 May 2009 21:27:06 +0000 (-0400)
Subject: Document thread registration in urcu.h
X-Git-Tag: v0.1~219
X-Git-Url: http://git.liburcu.org/?p=urcu.git;a=commitdiff_plain;h=92b752ee39652e7df5995ae7c7acc40ec1c9b9a5;ds=sidebyside

Document thread registration in urcu.h

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

diff --git a/urcu.h b/urcu.h
index b46033f..af7d75c 100644
--- a/urcu.h
+++ b/urcu.h
@@ -34,6 +34,14 @@
 #include <stdlib.h>
 #include <pthread.h>
 
+/*
+ * Important !
+ *
+ * Each thread containing read-side critical sections must be registered
+ * with rcu_register_thread() before calling rcu_read_lock().
+ * rcu_unregister_thread() should be called before the thread exits.
+ */
+
 #ifdef _LGPL_SOURCE
 
 #include <urcu-static.h>