diff options
| author | Andreas Gruenbacher <agruenba@redhat.com> | 2017-09-19 12:41:37 +0200 |
|---|---|---|
| committer | David S. Miller <davem@davemloft.net> | 2017-09-19 15:18:33 -0700 |
| commit | 0647169cf9aa441700eb8f23ea49be060626534b (patch) | |
| tree | 427c655a15c9ec37f63a5f568fea63a331548dd3 /lib/rhashtable.c | |
| parent | 6073512cc8e2c48bed5c6625c02c5e4ae50cec34 (diff) | |
| download | lwn-0647169cf9aa441700eb8f23ea49be060626534b.tar.gz lwn-0647169cf9aa441700eb8f23ea49be060626534b.zip | |
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>
Diffstat (limited to 'lib/rhashtable.c')
| -rw-r--r-- | lib/rhashtable.c | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/rhashtable.c b/lib/rhashtable.c index 707ca5d677c6..ddd7dde87c3c 100644 --- 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) |