aboutsummaryrefslogtreecommitdiffstats
path: root/include/linux/list.h
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@xenotime.net>2006-06-25 08:47:43 -0400
committerLinus Torvalds <torvalds@g5.osdl.org>2006-06-25 13:01:06 -0400
commit8e3a67a99231f9f3f476bc3449e93c9a6a17f2e0 (patch)
treec61f89a407b261b74a7eca70388c22e8f6db7744 /include/linux/list.h
parentfe96e57d77481c8c1b6b0381d7e086870ac394fa (diff)
[PATCH] list.h doc: change "counter" to "cursor"
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>
Diffstat (limited to 'include/linux/list.h')
-rw-r--r--include/linux/list.h52
1 files changed, 26 insertions, 26 deletions
diff --git a/include/linux/list.h b/include/linux/list.h
index 88ecfa8f31c3..37ca31b21bb7 100644
--- a/include/linux/list.h
+++ b/include/linux/list.h
@@ -351,7 +351,7 @@ static inline void list_splice_init(struct list_head *list,
351 351
352/** 352/**
353 * list_for_each - iterate over a list 353 * list_for_each - iterate over a list
354 * @pos: the &struct list_head to use as a loop counter. 354 * @pos: the &struct list_head to use as a loop cursor.
355 * @head: the head for your list. 355 * @head: the head for your list.
356 */ 356 */
357#define list_for_each(pos, head) \ 357#define list_for_each(pos, head) \
@@ -360,7 +360,7 @@ static inline void list_splice_init(struct list_head *list,
360 360
361/** 361/**
362 * __list_for_each - iterate over a list 362 * __list_for_each - iterate over a list
363 * @pos: the &struct list_head to use as a loop counter. 363 * @pos: the &struct list_head to use as a loop cursor.
364 * @head: the head for your list. 364 * @head: the head for your list.
365 * 365 *
366 * This variant differs from list_for_each() in that it's the 366 * This variant differs from list_for_each() in that it's the
@@ -373,7 +373,7 @@ static inline void list_splice_init(struct list_head *list,
373 373
374/** 374/**
375 * list_for_each_prev - iterate over a list backwards 375 * list_for_each_prev - iterate over a list backwards
376 * @pos: the &struct list_head to use as a loop counter. 376 * @pos: the &struct list_head to use as a loop cursor.
377 * @head: the head for your list. 377 * @head: the head for your list.
378 */ 378 */
379#define list_for_each_prev(pos, head) \ 379#define list_for_each_prev(pos, head) \
@@ -382,7 +382,7 @@ static inline void list_splice_init(struct list_head *list,
382 382
383/** 383/**
384 * list_for_each_safe - iterate over a list safe against removal of list entry 384 * list_for_each_safe - iterate over a list safe against removal of list entry
385 * @pos: the &struct list_head to use as a loop counter. 385 * @pos: the &struct list_head to use as a loop cursor.
386 * @n: another &struct list_head to use as temporary storage 386 * @n: another &struct list_head to use as temporary storage
387 * @head: the head for your list. 387 * @head: the head for your list.
388 */ 388 */
@@ -392,7 +392,7 @@ static inline void list_splice_init(struct list_head *list,
392 392
393/** 393/**
394 * list_for_each_entry - iterate over list of given type 394 * list_for_each_entry - iterate over list of given type
395 * @pos: the type * to use as a loop counter. 395 * @pos: the type * to use as a loop cursor.
396 * @head: the head for your list. 396 * @head: the head for your list.
397 * @member: the name of the list_struct within the struct. 397 * @member: the name of the list_struct within the struct.
398 */ 398 */
@@ -403,7 +403,7 @@ static inline void list_splice_init(struct list_head *list,
403 403
404/** 404/**
405 * list_for_each_entry_reverse - iterate backwards over list of given type. 405 * list_for_each_entry_reverse - iterate backwards over list of given type.
406 * @pos: the type * to use as a loop counter. 406 * @pos: the type * to use as a loop cursor.
407 * @head: the head for your list. 407 * @head: the head for your list.
408 * @member: the name of the list_struct within the struct. 408 * @member: the name of the list_struct within the struct.
409 */ 409 */
@@ -425,7 +425,7 @@ static inline void list_splice_init(struct list_head *list,
425 425
426/** 426/**
427 * list_for_each_entry_continue - continue iteration over list of given type 427 * list_for_each_entry_continue - continue iteration over list of given type
428 * @pos: the type * to use as a loop counter. 428 * @pos: the type * to use as a loop cursor.
429 * @head: the head for your list. 429 * @head: the head for your list.
430 * @member: the name of the list_struct within the struct. 430 * @member: the name of the list_struct within the struct.
431 * 431 *
@@ -439,7 +439,7 @@ static inline void list_splice_init(struct list_head *list,
439 439
440/** 440/**
441 * list_for_each_entry_from - iterate over list of given type from the current point 441 * list_for_each_entry_from - iterate over list of given type from the current point
442 * @pos: the type * to use as a loop counter. 442 * @pos: the type * to use as a loop cursor.
443 * @head: the head for your list. 443 * @head: the head for your list.
444 * @member: the name of the list_struct within the struct. 444 * @member: the name of the list_struct within the struct.
445 * 445 *
@@ -451,7 +451,7 @@ static inline void list_splice_init(struct list_head *list,
451 451
452/** 452/**
453 * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry 453 * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
454 * @pos: the type * to use as a loop counter. 454 * @pos: the type * to use as a loop cursor.
455 * @n: another type * to use as temporary storage 455 * @n: another type * to use as temporary storage
456 * @head: the head for your list. 456 * @head: the head for your list.
457 * @member: the name of the list_struct within the struct. 457 * @member: the name of the list_struct within the struct.
@@ -464,7 +464,7 @@ static inline void list_splice_init(struct list_head *list,
464 464
465/** 465/**
466 * list_for_each_entry_safe_continue 466 * list_for_each_entry_safe_continue
467 * @pos: the type * to use as a loop counter. 467 * @pos: the type * to use as a loop cursor.
468 * @n: another type * to use as temporary storage 468 * @n: another type * to use as temporary storage
469 * @head: the head for your list. 469 * @head: the head for your list.
470 * @member: the name of the list_struct within the struct. 470 * @member: the name of the list_struct within the struct.
@@ -480,7 +480,7 @@ static inline void list_splice_init(struct list_head *list,
480 480
481/** 481/**
482 * list_for_each_entry_safe_from 482 * list_for_each_entry_safe_from
483 * @pos: the type * to use as a loop counter. 483 * @pos: the type * to use as a loop cursor.
484 * @n: another type * to use as temporary storage 484 * @n: another type * to use as temporary storage
485 * @head: the head for your list. 485 * @head: the head for your list.
486 * @member: the name of the list_struct within the struct. 486 * @member: the name of the list_struct within the struct.
@@ -495,7 +495,7 @@ static inline void list_splice_init(struct list_head *list,
495 495
496/** 496/**
497 * list_for_each_entry_safe_reverse 497 * list_for_each_entry_safe_reverse
498 * @pos: the type * to use as a loop counter. 498 * @pos: the type * to use as a loop cursor.
499 * @n: another type * to use as temporary storage 499 * @n: another type * to use as temporary storage
500 * @head: the head for your list. 500 * @head: the head for your list.
501 * @member: the name of the list_struct within the struct. 501 * @member: the name of the list_struct within the struct.
@@ -511,7 +511,7 @@ static inline void list_splice_init(struct list_head *list,
511 511
512/** 512/**
513 * list_for_each_rcu - iterate over an rcu-protected list 513 * list_for_each_rcu - iterate over an rcu-protected list
514 * @pos: the &struct list_head to use as a loop counter. 514 * @pos: the &struct list_head to use as a loop cursor.
515 * @head: the head for your list. 515 * @head: the head for your list.
516 * 516 *
517 * This list-traversal primitive may safely run concurrently with 517 * This list-traversal primitive may safely run concurrently with
@@ -530,7 +530,7 @@ static inline void list_splice_init(struct list_head *list,
530 530
531/** 531/**
532 * list_for_each_safe_rcu 532 * list_for_each_safe_rcu
533 * @pos: the &struct list_head to use as a loop counter. 533 * @pos: the &struct list_head to use as a loop cursor.
534 * @n: another &struct list_head to use as temporary storage 534 * @n: another &struct list_head to use as temporary storage
535 * @head: the head for your list. 535 * @head: the head for your list.
536 * 536 *
@@ -547,7 +547,7 @@ static inline void list_splice_init(struct list_head *list,
547 547
548/** 548/**
549 * list_for_each_entry_rcu - iterate over rcu list of given type 549 * list_for_each_entry_rcu - iterate over rcu list of given type
550 * @pos: the type * to use as a loop counter. 550 * @pos: the type * to use as a loop cursor.
551 * @head: the head for your list. 551 * @head: the head for your list.
552 * @member: the name of the list_struct within the struct. 552 * @member: the name of the list_struct within the struct.
553 * 553 *
@@ -564,7 +564,7 @@ static inline void list_splice_init(struct list_head *list,
564 564
565/** 565/**
566 * list_for_each_continue_rcu 566 * list_for_each_continue_rcu
567 * @pos: the &struct list_head to use as a loop counter. 567 * @pos: the &struct list_head to use as a loop cursor.
568 * @head: the head for your list. 568 * @head: the head for your list.
569 * 569 *
570 * Iterate over an rcu-protected list, continuing after current point. 570 * Iterate over an rcu-protected list, continuing after current point.
@@ -814,8 +814,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
814 814
815/** 815/**
816 * hlist_for_each_entry - iterate over list of given type 816 * hlist_for_each_entry - iterate over list of given type
817 * @tpos: the type * to use as a loop counter. 817 * @tpos: the type * to use as a loop cursor.
818 * @pos: the &struct hlist_node to use as a loop counter. 818 * @pos: the &struct hlist_node to use as a loop cursor.
819 * @head: the head for your list. 819 * @head: the head for your list.
820 * @member: the name of the hlist_node within the struct. 820 * @member: the name of the hlist_node within the struct.
821 */ 821 */
@@ -827,8 +827,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
827 827
828/** 828/**
829 * hlist_for_each_entry_continue - iterate over a hlist continuing after current point 829 * hlist_for_each_entry_continue - iterate over a hlist continuing after current point
830 * @tpos: the type * to use as a loop counter. 830 * @tpos: the type * to use as a loop cursor.
831 * @pos: the &struct hlist_node to use as a loop counter. 831 * @pos: the &struct hlist_node to use as a loop cursor.
832 * @member: the name of the hlist_node within the struct. 832 * @member: the name of the hlist_node within the struct.
833 */ 833 */
834#define hlist_for_each_entry_continue(tpos, pos, member) \ 834#define hlist_for_each_entry_continue(tpos, pos, member) \
@@ -839,8 +839,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
839 839
840/** 840/**
841 * hlist_for_each_entry_from - iterate over a hlist continuing from current point 841 * hlist_for_each_entry_from - iterate over a hlist continuing from current point
842 * @tpos: the type * to use as a loop counter. 842 * @tpos: the type * to use as a loop cursor.
843 * @pos: the &struct hlist_node to use as a loop counter. 843 * @pos: the &struct hlist_node to use as a loop cursor.
844 * @member: the name of the hlist_node within the struct. 844 * @member: the name of the hlist_node within the struct.
845 */ 845 */
846#define hlist_for_each_entry_from(tpos, pos, member) \ 846#define hlist_for_each_entry_from(tpos, pos, member) \
@@ -850,8 +850,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
850 850
851/** 851/**
852 * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry 852 * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
853 * @tpos: the type * to use as a loop counter. 853 * @tpos: the type * to use as a loop cursor.
854 * @pos: the &struct hlist_node to use as a loop counter. 854 * @pos: the &struct hlist_node to use as a loop cursor.
855 * @n: another &struct hlist_node to use as temporary storage 855 * @n: another &struct hlist_node to use as temporary storage
856 * @head: the head for your list. 856 * @head: the head for your list.
857 * @member: the name of the hlist_node within the struct. 857 * @member: the name of the hlist_node within the struct.
@@ -864,8 +864,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
864 864
865/** 865/**
866 * hlist_for_each_entry_rcu - iterate over rcu list of given type 866 * hlist_for_each_entry_rcu - iterate over rcu list of given type
867 * @tpos: the type * to use as a loop counter. 867 * @tpos: the type * to use as a loop cursor.
868 * @pos: the &struct hlist_node to use as a loop counter. 868 * @pos: the &struct hlist_node to use as a loop cursor.
869 * @head: the head for your list. 869 * @head: the head for your list.
870 * @member: the name of the hlist_node within the struct. 870 * @member: the name of the hlist_node within the struct.
871 * 871 *