Document thread registration in urcu.h

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

diff --git a/urcu.h b/urcu.h
index b46033f29090582749b949f30e2a6d95e2723c79..af7d75cb7bc9e389ba9896a9207695d4feea9540 100644 (file)
--- 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>