linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Randy.Dunlap" <rdunlap@xenotime.net>
To: lkml <linux-kernel@vger.kernel.org>
Cc: akpm <akpm@osdl.org>
Subject: [PATCH 2/2] list.h doc: change "counter" to "control"
Date: Thu, 18 May 2006 10:54:00 -0700	[thread overview]
Message-ID: <20060518105400.2aac9f44.rdunlap@xenotime.net> (raw)

From: Randy Dunlap <rdunlap@xenotime.net>

Use loop "control" instead of loop "counter" for list iterator
descriptions.  They are not counters, they are controls or
pointers or positions.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
---
 include/linux/list.h |   52 +++++++++++++++++++++++++--------------------------
 1 files changed, 26 insertions(+), 26 deletions(-)

--- linux-2617-rc4g6.orig/include/linux/list.h
+++ linux-2617-rc4g6/include/linux/list.h
@@ -328,7 +328,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @head:	the head for your list.
  */
 #define list_for_each(pos, head) \
@@ -337,7 +337,7 @@ static inline void list_splice_init(stru
 
 /**
  * __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 control.
  * @head:	the head for your list.
  *
  * This variant differs from list_for_each() in that it's the
@@ -350,7 +350,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @head:	the head for your list.
  */
 #define list_for_each_prev(pos, head) \
@@ -359,7 +359,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @n:		another &struct list_head to use as temporary storage
  * @head:	the head for your list.
  */
@@ -369,7 +369,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @head:	the head for your list.
  * @member:	the name of the list_struct within the struct.
  */
@@ -380,7 +380,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @head:	the head for your list.
  * @member:	the name of the list_struct within the struct.
  */
@@ -402,7 +402,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @head:	the head for your list.
  * @member:	the name of the list_struct within the struct.
  *
@@ -416,7 +416,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @head:	the head for your list.
  * @member:	the name of the list_struct within the struct.
  *
@@ -428,7 +428,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @n:		another type * to use as temporary storage
  * @head:	the head for your list.
  * @member:	the name of the list_struct within the struct.
@@ -441,7 +441,7 @@ static inline void list_splice_init(stru
 
 /**
  * list_for_each_entry_safe_continue
- * @pos:	the type * to use as a loop counter.
+ * @pos:	the type * to use as a loop control.
  * @n:		another type * to use as temporary storage
  * @head:	the head for your list.
  * @member:	the name of the list_struct within the struct.
@@ -457,7 +457,7 @@ static inline void list_splice_init(stru
 
 /**
  * list_for_each_entry_safe_from
- * @pos:	the type * to use as a loop counter.
+ * @pos:	the type * to use as a loop control.
  * @n:		another type * to use as temporary storage
  * @head:	the head for your list.
  * @member:	the name of the list_struct within the struct.
@@ -472,7 +472,7 @@ static inline void list_splice_init(stru
 
 /**
  * list_for_each_entry_safe_reverse
- * @pos:	the type * to use as a loop counter.
+ * @pos:	the type * to use as a loop control.
  * @n:		another type * to use as temporary storage
  * @head:	the head for your list.
  * @member:	the name of the list_struct within the struct.
@@ -488,7 +488,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @head:	the head for your list.
  *
  * This list-traversal primitive may safely run concurrently with
@@ -507,7 +507,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @n:		another &struct list_head to use as temporary storage
  * @head:	the head for your list.
  *
@@ -524,7 +524,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @head:	the head for your list.
  * @member:	the name of the list_struct within the struct.
  *
@@ -541,7 +541,7 @@ static inline void list_splice_init(stru
 
 /**
  * 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 control.
  * @head:	the head for your list.
  *
  * Iterate over an rcu-protected list, continuing after current point.
@@ -791,8 +791,8 @@ static inline void hlist_add_after_rcu(s
 
 /**
  * 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 control.
+ * @pos:	the &struct hlist_node to use as a loop control.
  * @head:	the head for your list.
  * @member:	the name of the hlist_node within the struct.
  */
@@ -804,8 +804,8 @@ static inline void hlist_add_after_rcu(s
 
 /**
  * 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 control.
+ * @pos:	the &struct hlist_node to use as a loop control.
  * @member:	the name of the hlist_node within the struct.
  */
 #define hlist_for_each_entry_continue(tpos, pos, member)		 \
@@ -816,8 +816,8 @@ static inline void hlist_add_after_rcu(s
 
 /**
  * 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 control.
+ * @pos:	the &struct hlist_node to use as a loop control.
  * @member:	the name of the hlist_node within the struct.
  */
 #define hlist_for_each_entry_from(tpos, pos, member)			 \
@@ -827,8 +827,8 @@ static inline void hlist_add_after_rcu(s
 
 /**
  * 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 control.
+ * @pos:	the &struct hlist_node to use as a loop control.
  * @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.
@@ -841,8 +841,8 @@ static inline void hlist_add_after_rcu(s
 
 /**
  * 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 control.
+ * @pos:	the &struct hlist_node to use as a loop control.
  * @head:	the head for your list.
  * @member:	the name of the hlist_node within the struct.
  *


---

             reply	other threads:[~2006-05-18 17:51 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-05-18 17:54 Randy.Dunlap [this message]
     [not found] ` <7b69d1470605190837o44f2c0f5o4aa9faa421dfb3f7@mail.gmail.com>
2006-05-19 16:02   ` [PATCH 2/2] list.h doc: change "counter" to "control" Randy.Dunlap
2006-05-19 16:05     ` Andrew Morton
     [not found]       ` <7b69d1470605191010o37b5aafeud18263214519456a@mail.gmail.com>
2006-05-19 17:27         ` Randy.Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20060518105400.2aac9f44.rdunlap@xenotime.net \
    --to=rdunlap@xenotime.net \
    --cc=akpm@osdl.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).