From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Tue, 21 Aug 2012 22:45:37 +0000 (-0400)
Subject: rculfhash API documentation: document destroy RCU read-lock constraint
X-Git-Tag: v0.7.4~1
X-Git-Url: http://git.liburcu.org/?p=userspace-rcu.git;a=commitdiff_plain;h=969143888baf25e15bbba7f5dec78479be3588b2;ds=sidebyside

rculfhash API documentation: document destroy RCU read-lock constraint

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

diff --git a/urcu/rculfhash.h b/urcu/rculfhash.h
index 03ce593..0496662 100644
--- a/urcu/rculfhash.h
+++ b/urcu/rculfhash.h
@@ -175,6 +175,8 @@ struct cds_lfht *cds_lfht_new(unsigned long init_size,
  *
  * Return 0 on success, negative error value on error.
  * Threads calling this API need to be registered RCU read-side threads.
+ * cds_lfht_destroy should *not* be called from a RCU read-side critical
+ * section.
  */
 int cds_lfht_destroy(struct cds_lfht *ht, pthread_attr_t **attr);