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 <agruenba@redhat.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Andreas Gruenbacher 2017-09-19 12:41:37 +02:00 committed by David S. Miller
parent 6073512cc8
commit 0647169cf9
1 changed files with 5 additions and 4 deletions

View File

@ -735,9 +735,9 @@ EXPORT_SYMBOL_GPL(rhashtable_walk_exit);
* rhashtable_walk_start - Start a hash table walk * rhashtable_walk_start - Start a hash table walk
* @iter: Hash table iterator * @iter: Hash table iterator
* *
* Start a hash table walk. Note that we take the RCU lock in all * Start a hash table walk at the current iterator position. Note that we take
* cases including when we return an error. So you must always call * the RCU lock in all cases including when we return an error. So you must
* rhashtable_walk_stop to clean up. * always call rhashtable_walk_stop to clean up.
* *
* Returns zero if successful. * Returns zero if successful.
* *
@ -846,7 +846,8 @@ EXPORT_SYMBOL_GPL(rhashtable_walk_next);
* rhashtable_walk_stop - Finish a hash table walk * rhashtable_walk_stop - Finish a hash table walk
* @iter: Hash table iterator * @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) void rhashtable_walk_stop(struct rhashtable_iter *iter)
__releases(RCU) __releases(RCU)