xen/list: fix comments in include/xen/list.h

There are several places in list.h where "list_struct" is used instead
of "struct list_head". Fix that.

Signed-off-by: Juergen Gross <jgross@suse.com>
Acked-by: Jan Beulich <jbeulich@suse.com>
This commit is contained in:
Juergen Gross authored and Jan Beulich committed 2025-03-05 15:43:32 +01:00
1 parent 91db39013a
commit 9f78105500
1 file changed
+17 -17
+17 -17
View File
@@ -384,7 +384,7 @@ static inline void list_splice_init(struct list_head *list,
* list_entry - get the struct for this entry
* @ptr: the &struct list_head pointer.
* @type: the type of the struct this is embedded in.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*/
#define list_entry(ptr, type, member) \
container_of(ptr, type, member)
@@ -393,7 +393,7 @@ static inline void list_splice_init(struct list_head *list,
* list_first_entry - get the first element from a list
* @ptr: the list head to take the element from.
* @type: the type of the struct this is embedded in.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Note, that list is expected to be not empty.
*/
@@ -404,7 +404,7 @@ static inline void list_splice_init(struct list_head *list,
* list_last_entry - get the last element from a list
* @ptr: the list head to take the element from.
* @type: the type of the struct this is embedded in.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Note, that list is expected to be not empty.
*/
@@ -415,7 +415,7 @@ static inline void list_splice_init(struct list_head *list,
* list_first_entry_or_null - get the first element from a list
* @ptr: the list head to take the element from.
* @type: the type of the struct this is embedded in.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Note that if the list is empty, it returns NULL.
*/
@@ -426,7 +426,7 @@ static inline void list_splice_init(struct list_head *list,
* list_last_entry_or_null - get the last element from a list
* @ptr: the list head to take the element from.
* @type: the type of the struct this is embedded in.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Note that if the list is empty, it returns NULL.
*/
@@ -436,7 +436,7 @@ static inline void list_splice_init(struct list_head *list,
/**
* list_next_entry - get the next element in list
* @pos: the type * to cursor
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*/
#define list_next_entry(pos, member) \
list_entry((pos)->member.next, typeof(*(pos)), member)
@@ -444,7 +444,7 @@ static inline void list_splice_init(struct list_head *list,
/**
* list_prev_entry - get the prev element in list
* @pos: the type * to cursor
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*/
#define list_prev_entry(pos, member) \
list_entry((pos)->member.prev, typeof(*(pos)), member)
@@ -490,7 +490,7 @@ static inline void list_splice_init(struct list_head *list,
* list_for_each_entry - iterate over list of given type
* @pos: the type * to use as a loop cursor.
* @head: the head for your list.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*/
#define list_for_each_entry(pos, head, member) \
for ((pos) = list_entry((head)->next, typeof(*(pos)), member); \
@@ -501,7 +501,7 @@ static inline void list_splice_init(struct list_head *list,
* list_for_each_entry_reverse - iterate backwards over list of given type.
* @pos: the type * to use as a loop cursor.
* @head: the head for your list.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*/
#define list_for_each_entry_reverse(pos, head, member) \
for ((pos) = list_entry((head)->prev, typeof(*(pos)), member); \
@@ -513,7 +513,7 @@ static inline void list_splice_init(struct list_head *list,
* list_for_each_entry_continue
* @pos: the type * to use as a start point
* @head: the head of the list
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Prepares a pos entry for use as a start point in
* list_for_each_entry_continue.
@@ -525,7 +525,7 @@ static inline void list_splice_init(struct list_head *list,
* list_for_each_entry_continue - continue iteration over list of given type
* @pos: the type * to use as a loop cursor.
* @head: the head for your list.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Continue to iterate over list of given type, continuing after
* the current position.
@@ -540,7 +540,7 @@ static inline void list_splice_init(struct list_head *list,
* current point
* @pos: the type * to use as a loop cursor.
* @head: the head for your list.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Iterate over list of given type, continuing from current position.
*/
@@ -554,7 +554,7 @@ static inline void list_splice_init(struct list_head *list,
* @pos: the type * to use as a loop cursor.
* @n: another type * to use as temporary storage
* @head: the head for your list.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*/
#define list_for_each_entry_safe(pos, n, head, member) \
for ((pos) = list_entry((head)->next, typeof(*(pos)), member), \
@@ -567,7 +567,7 @@ static inline void list_splice_init(struct list_head *list,
* @pos: the type * to use as a loop cursor.
* @n: another type * to use as temporary storage
* @head: the head for your list.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Iterate over list of given type, continuing after current point,
* safe against removal of list entry.
@@ -583,7 +583,7 @@ static inline void list_splice_init(struct list_head *list,
* @pos: the type * to use as a loop cursor.
* @n: another type * to use as temporary storage
* @head: the head for your list.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Iterate over list of given type from current point, safe against
* removal of list entry.
@@ -598,7 +598,7 @@ static inline void list_splice_init(struct list_head *list,
* @pos: the type * to use as a loop cursor.
* @n: another type * to use as temporary storage
* @head: the head for your list.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* Iterate backwards over list of given type, safe against removal
* of list entry.
@@ -649,7 +649,7 @@ static inline void list_splice_init(struct list_head *list,
* list_for_each_entry_rcu - iterate over rcu list of given type
* @pos: the type * to use as a loop cursor.
* @head: the head for your list.
* @member: the name of the list_struct within the struct.
* @member: the name of the struct list_head within the struct.
*
* This list-traversal primitive may safely run concurrently with
* the _rcu list-mutation primitives such as list_add_rcu()
Reference in new issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.