Skip to content

Commit

Permalink
[PATCH] list.h doc: change "counter" to "cursor"
Browse files Browse the repository at this point in the history 
Use loop "cursor" instead of loop "counter" for list iterator descriptions.
They are not counters, they are pointers or positions.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
  • Loading branch information
Randy Dunlap authored and Linus Torvalds committed Jun 25, 2006
1 parent fe96e57 commit 8e3a67a
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions include/linux/list.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each - iterate over a list
* @pos: the &struct list_head to use as a loop counter.
* @pos: the &struct list_head to use as a loop cursor.
* @head: the head for your list.
*/
#define list_for_each(pos, head) \
Expand All @@ -360,7 +360,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* __list_for_each - iterate over a list
* @pos: the &struct list_head to use as a loop counter.
* @pos: the &struct list_head to use as a loop cursor.
* @head: the head for your list.
*
* This variant differs from list_for_each() in that it's the
Expand All @@ -373,7 +373,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_prev - iterate over a list backwards
* @pos: the &struct list_head to use as a loop counter.
* @pos: the &struct list_head to use as a loop cursor.
* @head: the head for your list.
*/
#define list_for_each_prev(pos, head) \
Expand All @@ -382,7 +382,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_safe - iterate over a list safe against removal of list entry
* @pos: the &struct list_head to use as a loop counter.
* @pos: the &struct list_head to use as a loop cursor.
* @n: another &struct list_head to use as temporary storage
* @head: the head for your list.
*/
Expand All @@ -392,7 +392,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 counter.
* @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.
*/
Expand All @@ -403,7 +403,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 counter.
* @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.
*/
Expand All @@ -425,7 +425,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 counter.
* @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.
*
Expand All @@ -439,7 +439,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_entry_from - iterate over list of given type from the current point
* @pos: the type * to use as a loop counter.
* @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.
*
Expand All @@ -451,7 +451,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
* @pos: the type * to use as a loop counter.
* @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.
Expand All @@ -464,7 +464,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_entry_safe_continue
* @pos: the type * to use as a loop counter.
* @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.
Expand All @@ -480,7 +480,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_entry_safe_from
* @pos: the type * to use as a loop counter.
* @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.
Expand All @@ -495,7 +495,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_entry_safe_reverse
* @pos: the type * to use as a loop counter.
* @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.
Expand All @@ -511,7 +511,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_rcu - iterate over an rcu-protected list
* @pos: the &struct list_head to use as a loop counter.
* @pos: the &struct list_head to use as a loop cursor.
* @head: the head for your list.
*
* This list-traversal primitive may safely run concurrently with
Expand All @@ -530,7 +530,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_safe_rcu
* @pos: the &struct list_head to use as a loop counter.
* @pos: the &struct list_head to use as a loop cursor.
* @n: another &struct list_head to use as temporary storage
* @head: the head for your list.
*
Expand All @@ -547,7 +547,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 counter.
* @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.
*
Expand All @@ -564,7 +564,7 @@ static inline void list_splice_init(struct list_head *list,

/**
* list_for_each_continue_rcu
* @pos: the &struct list_head to use as a loop counter.
* @pos: the &struct list_head to use as a loop cursor.
* @head: the head for your list.
*
* Iterate over an rcu-protected list, continuing after current point.
Expand Down Expand Up @@ -814,8 +814,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,

/**
* hlist_for_each_entry - iterate over list of given type
* @tpos: the type * to use as a loop counter.
* @pos: the &struct hlist_node to use as a loop counter.
* @tpos: the type * to use as a loop cursor.
* @pos: the &struct hlist_node to use as a loop cursor.
* @head: the head for your list.
* @member: the name of the hlist_node within the struct.
*/
Expand All @@ -827,8 +827,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,

/**
* hlist_for_each_entry_continue - iterate over a hlist continuing after current point
* @tpos: the type * to use as a loop counter.
* @pos: the &struct hlist_node to use as a loop counter.
* @tpos: the type * to use as a loop cursor.
* @pos: the &struct hlist_node to use as a loop cursor.
* @member: the name of the hlist_node within the struct.
*/
#define hlist_for_each_entry_continue(tpos, pos, member) \
Expand All @@ -839,8 +839,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,

/**
* hlist_for_each_entry_from - iterate over a hlist continuing from current point
* @tpos: the type * to use as a loop counter.
* @pos: the &struct hlist_node to use as a loop counter.
* @tpos: the type * to use as a loop cursor.
* @pos: the &struct hlist_node to use as a loop cursor.
* @member: the name of the hlist_node within the struct.
*/
#define hlist_for_each_entry_from(tpos, pos, member) \
Expand All @@ -850,8 +850,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,

/**
* hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
* @tpos: the type * to use as a loop counter.
* @pos: the &struct hlist_node to use as a loop counter.
* @tpos: the type * to use as a loop cursor.
* @pos: the &struct hlist_node to use as a loop cursor.
* @n: another &struct hlist_node to use as temporary storage
* @head: the head for your list.
* @member: the name of the hlist_node within the struct.
Expand All @@ -864,8 +864,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,

/**
* hlist_for_each_entry_rcu - iterate over rcu list of given type
* @tpos: the type * to use as a loop counter.
* @pos: the &struct hlist_node to use as a loop counter.
* @tpos: the type * to use as a loop cursor.
* @pos: the &struct hlist_node to use as a loop cursor.
* @head: the head for your list.
* @member: the name of the hlist_node within the struct.
*
Expand Down

0 comments on commit 8e3a67a

Please sign in to comment.