From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Thu, 29 Sep 2011 21:40:01 +0000 (-0400)
Subject: call_rcu: Document call_rcu requirements
X-Git-Tag: v0.6.5~1
X-Git-Url: http://git.liburcu.org/?p=urcu.git;a=commitdiff_plain;h=03c5a8f55284f3627b93bc66284347804c77b892

call_rcu: Document call_rcu requirements

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/urcu-call-rcu.h b/urcu-call-rcu.h
index 5ea0c23..d00bb4a 100644
--- a/urcu-call-rcu.h
+++ b/urcu-call-rcu.h
@@ -75,7 +75,7 @@ int set_cpu_call_rcu_data(int cpu, struct call_rcu_data *crdp);
 struct call_rcu_data *get_default_call_rcu_data(void);
 /*
  * get_call_rcu_data should be called from registered RCU read-side
- * threads.
+ * threads. For the QSBR flavor, the caller should be online.
  */
 struct call_rcu_data *get_call_rcu_data(void);
 struct call_rcu_data *get_thread_call_rcu_data(void);
@@ -83,6 +83,7 @@ void set_thread_call_rcu_data(struct call_rcu_data *crdp);
 int create_all_cpu_call_rcu_data(unsigned long flags);
 /*
  * call_rcu should be called from registered RCU read-side threads.
+ * For the QSBR flavor, the caller should be online.
  */
 void call_rcu(struct rcu_head *head,
 	      void (*func)(struct rcu_head *head));