Commit c84716c4 authored by NeilBrown's avatar NeilBrown Committed by Jiri Kosina
Browse files

list/hashtable: minor documentation corrections. 



hash_for_each_safe() and hash_for_each_possible_safe()
need to be passed a temp 'struct hlist_node' pointer, but
do not say that in the documentation - they just say
a 'struct'.

Also the documentation for hlist_for_each_entry_safe()
describes @n as "another" hlist_node, but in reality it is
the only one.

Signed-off-by: default avatarNeilBrown <neilb@suse.com>
Reviewed-by: default avatarMukesh Ojha <mojha@codeaurora.org>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
parent fb33c651

include/linux/hashtable.h

+2 −2
Original line number Diff line number Diff line
@@ -145,7 +145,7 @@ static inline void hash_del_rcu(struct hlist_node *node) 
 * hash entry

 * @name: hashtable to iterate

 * @bkt: integer to use as bucket loop cursor

 * @tmp: a &struct used for temporary storage

 * @tmp: a &struct hlist_node used for temporary storage

 * @obj: the type * to use as a loop cursor for each entry

 * @member: the name of the hlist_node within the struct

 */
@@ -197,7 +197,7 @@ static inline void hash_del_rcu(struct hlist_node *node) 
 * same bucket safe against removals

 * @name: hashtable to iterate

 * @obj: the type * to use as a loop cursor for each entry

 * @tmp: a &struct used for temporary storage

 * @tmp: a &struct hlist_node used for temporary storage

 * @member: the name of the hlist_node within the struct

 * @key: the key of the objects to iterate over

 */

include/linux/list.h

+1 −1
Original line number Diff line number Diff line
@@ -989,7 +989,7 @@ static inline void hlist_move_list(struct hlist_head *old, 
/**

 * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry

 * @pos:	the type * to use as a loop cursor.

 * @n:		another &struct hlist_node to use as temporary storage

 * @n:		a &struct hlist_node to use as temporary storage

 * @head:	the head for your list.

 * @member:	the name of the hlist_node within the struct.

 */

CRA Git | Maintained and supported by SUSTech CRA and CCSE