rhashtable: Documentation tweak

Andreas Gruenbacher · davem330 · commit 0647169cf9aa · 2017-09-19T15:18:33.000-07:00
Clarify that rhashtable_walk_{stop,start} will not reset the iterator to
the beginning of the hash table.  Confusion between rhashtable_walk_enter
and rhashtable_walk_start has already lead to a bug.

Signed-off-by: Andreas Gruenbacher &lt;agruenba@redhat.com&gt;
Signed-off-by: David S. Miller &lt;davem@davemloft.net&gt;
diff --git a/lib/rhashtable.c b/lib/rhashtable.c
@@ -735,9 +735,9 @@ EXPORT_SYMBOL_GPL(rhashtable_walk_exit);
  * rhashtable_walk_start - Start a hash table walk
  * @iter:	Hash table iterator
  *
- * Start a hash table walk.  Note that we take the RCU lock in all
- * cases including when we return an error.  So you must always call
- * rhashtable_walk_stop to clean up.
+ * Start a hash table walk at the current iterator position.  Note that we take
+ * the RCU lock in all cases including when we return an error.  So you must
+ * always call rhashtable_walk_stop to clean up.
  *
  * Returns zero if successful.
  *
@@ -846,7 +846,8 @@ EXPORT_SYMBOL_GPL(rhashtable_walk_next);
  * rhashtable_walk_stop - Finish a hash table walk
  * @iter:	Hash table iterator
  *
- * Finish a hash table walk.
+ * Finish a hash table walk.  Does not reset the iterator to the start of the
+ * hash table.
  */
 void rhashtable_walk_stop(struct rhashtable_iter *iter)
 	__releases(RCU)

Original file line number	Diff line number	Diff line change
`@@ -735,9 +735,9 @@ EXPORT_SYMBOL_GPL(rhashtable_walk_exit);`
`735`	`735`	`* rhashtable_walk_start - Start a hash table walk`
`736`	`736`	`* @iter: Hash table iterator`
`737`	`737`	`*`
`738`		`- * Start a hash table walk. Note that we take the RCU lock in all`
`739`		`- * cases including when we return an error. So you must always call`
`740`		`- * rhashtable_walk_stop to clean up.`
	`738`	`+ * Start a hash table walk at the current iterator position. Note that we take`
	`739`	`+ * the RCU lock in all cases including when we return an error. So you must`
	`740`	`+ * always call rhashtable_walk_stop to clean up.`
`741`	`741`	`*`
`742`	`742`	`* Returns zero if successful.`
`743`	`743`	`*`
`@@ -846,7 +846,8 @@ EXPORT_SYMBOL_GPL(rhashtable_walk_next);`
`846`	`846`	`* rhashtable_walk_stop - Finish a hash table walk`
`847`	`847`	`* @iter: Hash table iterator`
`848`	`848`	`*`
`849`		`- * Finish a hash table walk.`
	`849`	`+ * Finish a hash table walk. Does not reset the iterator to the start of the`
	`850`	`+ * hash table.`
`850`	`851`	`*/`
`851`	`852`	`void rhashtable_walk_stop(struct rhashtable_iter *iter)`
`852`	`853`	`__releases(RCU)`