|author||Wu Fengguang <email@example.com>||2008-11-27 11:42:22 +0100|
|committer||Jiri Kosina <firstname.lastname@example.org>||2009-01-06 11:28:05 +0100|
trivial: radix-tree: document wrap-around issue of radix_tree_next_hole()
And some 80-line cleanups. Signed-off-by: Wu Fengguang <email@example.com> Signed-off-by: Jiri Kosina <firstname.lastname@example.org>
Diffstat (limited to 'lib/radix-tree.c')
1 files changed, 6 insertions, 5 deletions
diff --git a/lib/radix-tree.c b/lib/radix-tree.c
index be86b32bc87..a7f5217dd67 100644
@@ -640,13 +640,14 @@ EXPORT_SYMBOL(radix_tree_tag_get);
* Returns: the index of the hole if found, otherwise returns an index
* outside of the set specified (in which case 'return - index >= max_scan'
- * will be true).
+ * will be true). In rare cases of index wrap-around, 0 will be returned.
* radix_tree_next_hole may be called under rcu_read_lock. However, like
- * radix_tree_gang_lookup, this will not atomically search a snapshot of the
- * tree at a single point in time. For example, if a hole is created at index
- * 5, then subsequently a hole is created at index 10, radix_tree_next_hole
- * covering both indexes may return 10 if called under rcu_read_lock.
+ * radix_tree_gang_lookup, this will not atomically search a snapshot of
+ * the tree at a single point in time. For example, if a hole is created
+ * at index 5, then subsequently a hole is created at index 10,
+ * radix_tree_next_hole covering both indexes may return 10 if called
+ * under rcu_read_lock.
unsigned long radix_tree_next_hole(struct radix_tree_root *root,
unsigned long index, unsigned long max_scan)