rhashtable: Documentation tweak

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 <[email protected]>
Signed-off-by: David S. Miller <[email protected]>
This commit is contained in:
Andreas Gruenbacher authored and David S. Miller committed 2017-09-19 15:18:33 -07:00
1 parent 6073512cc8
commit 0647169cf9
1 file changed
+5 -4
+5 -4
View File
@@ -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)