aboutsummaryrefslogtreecommitdiffstats
path: root/include/linux/list.h
diff options
context:
space:
mode:
authorNeilBrown <neilb@suse.com>2019-03-21 14:54:22 +1100
committerJiri Kosina <jkosina@suse.cz>2020-03-17 17:25:06 +0100
commitc84716c401d34eed5ed45a9c3553b08b0d541b9a (patch)
treeee3f27f3f74f14bb5217b3d9036cede9d70c20b1 /include/linux/list.h
parentLinux 5.6-rc6 (diff)
downloadlinux-dev-c84716c401d34eed5ed45a9c3553b08b0d541b9a.tar.xz
linux-dev-c84716c401d34eed5ed45a9c3553b08b0d541b9a.zip
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: NeilBrown <neilb@suse.com> Reviewed-by: Mukesh Ojha <mojha@codeaurora.org> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
Diffstat (limited to 'include/linux/list.h')
-rw-r--r--include/linux/list.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/linux/list.h b/include/linux/list.h
index 884216db3246..aff44d34f4e4 100644
--- a/include/linux/list.h
+++ b/include/linux/list.h
@@ -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.
*/