Skip to contentSkip to conversation

lib: radix_tree: Fix error in docs about locks

PATCH New Adam Barth 1 participant 1 message Dec 21, 2015

lore
Share & tools
lore

Adam Barth

author
#0 lore raw

PATCH v2 1/1 lib: radix_tree: Fix error in docs about locks

This text refers to the "first 7 functions", which was correct when written but became incorrect when Johannes Weiner added another function to the list in 139e561660fe ("lib: radix_tree: tree node interface").

Remove the sentence because it doesn't add any additional information and would need to be updated each time the list changes.

---
Changes in v2:
- Removed the sentence entirely, as suggested by derRichard.

 include/linux/radix-tree.h | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
include/linux/radix-tree.h +3 -4
index 33170db..204aa02 100644
@@ -154,10 +154,9 @@ do {									\
  * radix_tree_gang_lookup_tag_slot
  * radix_tree_tagged
  *
- * The first 7 functions are able to be called locklessly, using RCU. The
- * caller must ensure calls to these functions are made within rcu_read_lock()
- * regions. Other readers (lock-free or otherwise) and modifications may be
- * running concurrently.
+ * The caller must ensure calls to these functions (other than
+ * radix_tree_tagged) are made within rcu_read_lock() regions. Other readers
+ * (lock-free or otherwise) and modifications may be running concurrently.
  *
  * It is still required that the caller manage the synchronization and lifetimes
  * of the items. So if RCU lock-free lookups are used, typically this would mean
Signature · 1 line
1.9.1