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 03ce5932b4837aa8d4c5f68f6b9cee47dcddcb10..0496662e209c250f0e11ea1e83cecd25eaa06eae 100644 (file)
--- 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);