diff options
| author | Kenneth R Westerback <krw@cvs.openbsd.org> | 2003-05-17 18:40:13 +0000 |
|---|---|---|
| committer | Kenneth R Westerback <krw@cvs.openbsd.org> | 2003-05-17 18:40:13 +0000 |
| commit | 8674de0af687b72185752755f79ef186009fde48 (patch) | |
| tree | 41421513f922997187da85d993668f18a4ad4ba3 | |
| parent | 4b8ab9aa0889d4c4353a47a23f73ef70cad7e558 (diff) | |
Emphasize that TAILQ_FOREACH and TAILQ_FOREACH_REVERSE are the
preferred ways to traverse a list. Use TAILQ_FOREACH in a forward
traversal example.
Use correct number of parameters for TAILQ_FOREACH_REVERSE as pointed
out by Markus.
ok henning@ jmc@ markus@
| -rw-r--r-- | share/man/man3/queue.3 | 35 |
1 files changed, 20 insertions, 15 deletions
diff --git a/share/man/man3/queue.3 b/share/man/man3/queue.3 index 8557c834847..9cdfe211565 100644 --- a/share/man/man3/queue.3 +++ b/share/man/man3/queue.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: queue.3,v 1.28 2003/04/16 07:51:22 mickey Exp $ +.\" $OpenBSD: queue.3,v 1.29 2003/05/17 18:40:12 krw Exp $ .\" $NetBSD: queue.3,v 1.4 1995/07/03 00:25:36 mycroft Exp $ .\" .\" Copyright (c) 1993 The Regents of the University of California. @@ -799,25 +799,27 @@ macro removes the element .Fa elm from the tail queue. .Pp -The -.Fn TAILQ_FIRST , -.Fn TAILQ_NEXT , -.Fn TAILQ_LAST +.Fn TAILQ_FOREACH and -.Fn TAILQ_PREV -macros can be used to traverse a tail queue. -The +.Fn TAILQ_FOREACH_REVERSE +are used for traversing a tail queue. .Fn TAILQ_FOREACH -is used for tail queue traversal +starts at the first element and proceeds towards the last. +.Fn TAILQ_FOREACH_REVERSE +starts at the last element and proceeds towards the first. .Bd -literal -offset indent -TAILQ_FOREACH(np, head, NAME) +TAILQ_FOREACH(np, &head, NAME) +TAILQ_FOREACH_REVERSE(np, &head, NAME, HEADNAME) .Ed .Pp The -.Fn TAILQ_FOREACH_REVERSE -acts like -.Fn TAILQ_FOREACH -but traverses the tail queue in reverse. +.Fn TAILQ_FIRST , +.Fn TAILQ_NEXT , +.Fn TAILQ_LAST +and +.Fn TAILQ_PREV +macros can be used to manually traverse a tail queue or an arbitrary part of +one. .Pp The .Fn TAILQ_EMPTY @@ -846,7 +848,10 @@ TAILQ_INSERT_AFTER(&head, n1, n2, entries); n2 = malloc(sizeof(struct entry)); /* Insert before. */ TAILQ_INSERT_BEFORE(n1, n2, entries); /* Forward traversal. */ -for (np = TAILQ_FIRST(&head); np != NULL; np = TAILQ_NEXT(np, entries)) +TAILQ_FOREACH(np, &head, entries) + np-> ... + /* Manual forward traversal */ +for (np = n2; np != NULL; np = TAILQ_NEXT(np, entries)) np-> ... /* Delete. */ while (np = TAILQ_FIRST(&head)) |