From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Tue, 19 Nov 2013 14:53:54 +0000 (-0500)
Subject: rculfhash: document max_nr_buckets = 0
X-Git-Tag: v0.8.2~18
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=1739c714b36e09d3be0f31908b316be257677fb9;p=userspace-rcu.git

rculfhash: document max_nr_buckets = 0

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

diff --git a/urcu/rculfhash.h b/urcu/rculfhash.h
index afd0c3e..7a411ad 100644
--- a/urcu/rculfhash.h
+++ b/urcu/rculfhash.h
@@ -133,7 +133,8 @@ struct cds_lfht *_cds_lfht_new(unsigned long init_size,
  * @min_nr_alloc_buckets: the minimum number of allocated buckets.
  *                        (must be power of two)
  * @max_nr_buckets: the maximum number of hash table buckets allowed.
- *                  (must be power of two)
+ *                  (must be power of two, 0 is accepted, means
+ *                  "infinite")
  * @flags: hash table creation flags (can be combined with bitwise or: '|').
  *           0: no flags.
  *           CDS_LFHT_AUTO_RESIZE: automatically resize hash table.