Linux-man Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] queue.3: slist: Complete example
@ 2020-10-11 15:51 Alejandro Colomar
  2020-10-11 16:05 ` Michael Kerrisk (man-pages)
  0 siblings, 1 reply; 2+ messages in thread
From: Alejandro Colomar @ 2020-10-11 15:51 UTC (permalink / raw)
  To: mtk.manpages; +Cc: Alejandro Colomar, linux-man, libc-alpha

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
 man3/queue.3 | 102 +++++++++++++++++++++++++++++----------------------
 1 file changed, 59 insertions(+), 43 deletions(-)

diff --git a/man3/queue.3 b/man3/queue.3
index ea43f018b..63c43dadc 100644
--- a/man3/queue.3
+++ b/man3/queue.3
@@ -545,49 +545,8 @@ from the list.
 .\" .Fa head1
 .\" and
 .\" .Fa head2 .
-.Ss Singly-linked list example
-.Bd -literal
-SLIST_HEAD(slisthead, entry) head =
-    SLIST_HEAD_INITIALIZER(head);
-struct slisthead *headp;		/* Singly-linked List
-                                           head. */
-struct entry {
-	...
-	SLIST_ENTRY(entry) entries;	/* Singly-linked List. */
-	...
-} *n1, *n2, *n3, *np;
-
-SLIST_INIT(&head);			/* Initialize the list. */
-
-n1 = malloc(sizeof(struct entry));	/* Insert at the head. */
-SLIST_INSERT_HEAD(&head, n1, entries);
-
-n2 = malloc(sizeof(struct entry));	/* Insert after. */
-SLIST_INSERT_AFTER(n1, n2, entries);
-
-SLIST_REMOVE(&head, n2, entry, entries);/* Deletion. */
-free(n2);
-
-n3 = SLIST_FIRST(&head);
-SLIST_REMOVE_HEAD(&head, entries);	/* Deletion from the head. */
-free(n3);
-					/* Forward traversal. */
-SLIST_FOREACH(np, &head, entries)
-	np\-> ...
-.\"					/* Safe forward traversal. */
-.\"SLIST_FOREACH_SAFE(np, &head, entries, np_temp) {
-.\"	np\->do_stuff();
-.\"	...
-.\"	SLIST_REMOVE(&head, np, entry, entries);
-.\"	free(np);
-.\"}
-
-while (!SLIST_EMPTY(&head)) {		/* List Deletion. */
-	n1 = SLIST_FIRST(&head);
-	SLIST_REMOVE_HEAD(&head, entries);
-	free(n1);
-}
-.Ed
+.Pp
+See the EXAMPLES section below for an example program using a singly-linked list.
 .Ss Singly-linked tail queues
 A singly-linked tail queue is headed by a structure defined by the
 .Nm STAILQ_HEAD
@@ -1409,6 +1368,63 @@ while (n1 != (void *)&head) {
 CIRCLEQ_INIT(&head);
 .Ed
 .Sh EXAMPLES
+.Ss Singly-linked list example
+.Bd -literal
+
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/queue.h>
+
+struct entry {
+    int data;
+    SLIST_ENTRY(entry) entries;             /* Singly-linked List. */
+};
+
+SLIST_HEAD(slisthead, entry);
+
+int
+main(void)
+{
+    struct entry    *n1, *n2, *n3, *np;
+    struct slisthead head;                  /* Singly-linked List
+                                               head. */
+
+    SLIST_INIT(&head);                      /* Initialize the queue. */
+
+    n1 = malloc(sizeof(struct entry));      /* Insert at the head. */
+    SLIST_INSERT_HEAD(&head, n1, entries);
+
+    n2 = malloc(sizeof(struct entry));      /* Insert after. */
+    SLIST_INSERT_AFTER(n1, n2, entries);
+
+    SLIST_REMOVE(&head, n2, entry, entries);/* Deletion. */
+    free(n2);
+
+    n3 = SLIST_FIRST(&head);
+    SLIST_REMOVE_HEAD(&head, entries);      /* Deletion from the head. */
+    free(n3);
+
+    for (int i = 0; i < 5; i++) {
+        n1 = malloc(sizeof(struct entry));
+        SLIST_INSERT_HEAD(&head, n1, entries);
+        n1->data = i;
+    }
+
+                                            /* Forward traversal. */
+    SLIST_FOREACH(np, &head, entries)
+        printf("%i\en", np->data);
+
+    while (!SLIST_EMPTY(&head)) {           /* List Deletion. */
+        n1 = SLIST_FIRST(&head);
+        SLIST_REMOVE_HEAD(&head, entries);
+        free(n1);
+    }
+    SLIST_INIT(&head);
+
+    exit(EXIT_SUCCESS);
+}
+.Ed
 .Ss Tail queue example
 .Bd -literal
 #include <stddef.h>
-- 
2.28.0


^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] queue.3: slist: Complete example
  2020-10-11 15:51 [PATCH] queue.3: slist: Complete example Alejandro Colomar
@ 2020-10-11 16:05 ` Michael Kerrisk (man-pages)
  0 siblings, 0 replies; 2+ messages in thread
From: Michael Kerrisk (man-pages) @ 2020-10-11 16:05 UTC (permalink / raw)
  To: Alejandro Colomar; +Cc: mtk.manpages, linux-man, libc-alpha

On 10/11/20 5:51 PM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>

Thanks, Alex. Patch applied.

With best regards,

Michael

> ---
>  man3/queue.3 | 102 +++++++++++++++++++++++++++++----------------------
>  1 file changed, 59 insertions(+), 43 deletions(-)
> 
> diff --git a/man3/queue.3 b/man3/queue.3
> index ea43f018b..63c43dadc 100644
> --- a/man3/queue.3
> +++ b/man3/queue.3
> @@ -545,49 +545,8 @@ from the list.
>  .\" .Fa head1
>  .\" and
>  .\" .Fa head2 .
> -.Ss Singly-linked list example
> -.Bd -literal
> -SLIST_HEAD(slisthead, entry) head =
> -    SLIST_HEAD_INITIALIZER(head);
> -struct slisthead *headp;		/* Singly-linked List
> -                                           head. */
> -struct entry {
> -	...
> -	SLIST_ENTRY(entry) entries;	/* Singly-linked List. */
> -	...
> -} *n1, *n2, *n3, *np;
> -
> -SLIST_INIT(&head);			/* Initialize the list. */
> -
> -n1 = malloc(sizeof(struct entry));	/* Insert at the head. */
> -SLIST_INSERT_HEAD(&head, n1, entries);
> -
> -n2 = malloc(sizeof(struct entry));	/* Insert after. */
> -SLIST_INSERT_AFTER(n1, n2, entries);
> -
> -SLIST_REMOVE(&head, n2, entry, entries);/* Deletion. */
> -free(n2);
> -
> -n3 = SLIST_FIRST(&head);
> -SLIST_REMOVE_HEAD(&head, entries);	/* Deletion from the head. */
> -free(n3);
> -					/* Forward traversal. */
> -SLIST_FOREACH(np, &head, entries)
> -	np\-> ...
> -.\"					/* Safe forward traversal. */
> -.\"SLIST_FOREACH_SAFE(np, &head, entries, np_temp) {
> -.\"	np\->do_stuff();
> -.\"	...
> -.\"	SLIST_REMOVE(&head, np, entry, entries);
> -.\"	free(np);
> -.\"}
> -
> -while (!SLIST_EMPTY(&head)) {		/* List Deletion. */
> -	n1 = SLIST_FIRST(&head);
> -	SLIST_REMOVE_HEAD(&head, entries);
> -	free(n1);
> -}
> -.Ed
> +.Pp
> +See the EXAMPLES section below for an example program using a singly-linked list.
>  .Ss Singly-linked tail queues
>  A singly-linked tail queue is headed by a structure defined by the
>  .Nm STAILQ_HEAD
> @@ -1409,6 +1368,63 @@ while (n1 != (void *)&head) {
>  CIRCLEQ_INIT(&head);
>  .Ed
>  .Sh EXAMPLES
> +.Ss Singly-linked list example
> +.Bd -literal
> +
> +#include <stddef.h>
> +#include <stdio.h>
> +#include <stdlib.h>
> +#include <sys/queue.h>
> +
> +struct entry {
> +    int data;
> +    SLIST_ENTRY(entry) entries;             /* Singly-linked List. */
> +};
> +
> +SLIST_HEAD(slisthead, entry);
> +
> +int
> +main(void)
> +{
> +    struct entry    *n1, *n2, *n3, *np;
> +    struct slisthead head;                  /* Singly-linked List
> +                                               head. */
> +
> +    SLIST_INIT(&head);                      /* Initialize the queue. */
> +
> +    n1 = malloc(sizeof(struct entry));      /* Insert at the head. */
> +    SLIST_INSERT_HEAD(&head, n1, entries);
> +
> +    n2 = malloc(sizeof(struct entry));      /* Insert after. */
> +    SLIST_INSERT_AFTER(n1, n2, entries);
> +
> +    SLIST_REMOVE(&head, n2, entry, entries);/* Deletion. */
> +    free(n2);
> +
> +    n3 = SLIST_FIRST(&head);
> +    SLIST_REMOVE_HEAD(&head, entries);      /* Deletion from the head. */
> +    free(n3);
> +
> +    for (int i = 0; i < 5; i++) {
> +        n1 = malloc(sizeof(struct entry));
> +        SLIST_INSERT_HEAD(&head, n1, entries);
> +        n1->data = i;
> +    }
> +
> +                                            /* Forward traversal. */
> +    SLIST_FOREACH(np, &head, entries)
> +        printf("%i\en", np->data);
> +
> +    while (!SLIST_EMPTY(&head)) {           /* List Deletion. */
> +        n1 = SLIST_FIRST(&head);
> +        SLIST_REMOVE_HEAD(&head, entries);
> +        free(n1);
> +    }
> +    SLIST_INIT(&head);
> +
> +    exit(EXIT_SUCCESS);
> +}
> +.Ed
>  .Ss Tail queue example
>  .Bd -literal
>  #include <stddef.h>
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, back to index

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-11 15:51 [PATCH] queue.3: slist: Complete example Alejandro Colomar
2020-10-11 16:05 ` Michael Kerrisk (man-pages)

Linux-man Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-man/0 linux-man/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-man linux-man/ https://lore.kernel.org/linux-man \
		linux-man@vger.kernel.org
	public-inbox-index linux-man

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-man


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git