Skip to contentSkip to conversation

queue.3: Replace incomplete example by a complete example

PATCH In review Alejandro Colomar 3 participants 7 messages Oct 10, 2020 – Oct 12, 2020 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 queue.3: Replace incomplete example by a complete example

I added the EXAMPLES section.
The examples in this page are incomplete
(you can't copy&paste&compile&run).
I fixed the one about TAILQ first,
and the rest should follow.

---

Hi Michael,

I think this page needs a big overhaul.

First of all, it's a very big page,
where it's a bit difficult to go to the subsection you want. Then, the examples are incomplete.
And also, the language of the page is weird.

I thought about having queue.h with an overview of all the different data structures, and the differences about them.

And then separate pages for each data structure:
slist.3, list.3,
stailq.3, tailq.3,
simpleq.3 (which right now isn't documented),
and circleq.3
with details about each macro and a complete example program.

Your thoughts?

Cheers,

Alex

 man3/queue.3 | 115 ++++++++++++++++++++++++++-------------------------
 1 file changed, 59 insertions(+), 56 deletions(-)
man3/queue.3 +59 -56
index 55cd5847e..ea43f018b 100644
@@ -1220,62 +1220,8 @@ from the tail queue.
 .\" .Fa head1
 .\" and
 .\" .Fa head2 .
-.Ss Tail queue example
-.Bd -literal
-TAILQ_HEAD(tailhead, entry) head =
-    TAILQ_HEAD_INITIALIZER(head);
-struct tailhead *headp;			/* Tail queue head. */
-struct entry {
-	...
-	TAILQ_ENTRY(entry) entries;	/* Tail queue. */
-	...
-} *n1, *n2, *n3, *np;
-
-TAILQ_INIT(&head);			/* Initialize the queue. */
-
-n1 = malloc(sizeof(struct entry));	/* Insert at the head. */
-TAILQ_INSERT_HEAD(&head, n1, entries);
-
-n1 = malloc(sizeof(struct entry));	/* Insert at the tail. */
-TAILQ_INSERT_TAIL(&head, n1, entries);
-
-n2 = malloc(sizeof(struct entry));	/* Insert after. */
-TAILQ_INSERT_AFTER(&head, n1, n2, entries);
-
-n3 = malloc(sizeof(struct entry));	/* Insert before. */
-TAILQ_INSERT_BEFORE(n2, n3, entries);
-
-TAILQ_REMOVE(&head, n2, entries);	/* Deletion. */
-free(n2);
-					/* Forward traversal. */
-TAILQ_FOREACH(np, &head, entries)
-	np\-> ...
-.\" 					/* Safe forward traversal. */
-.\" TAILQ_FOREACH_SAFE(np, &head, entries, np_temp) {
-.\" 	np\->do_stuff();
-.\" 	...
-.\" 	TAILQ_REMOVE(&head, np, entries);
-.\" 	free(np);
-.\" }
-					/* Reverse traversal. */
-TAILQ_FOREACH_REVERSE(np, &head, tailhead, entries)
-	np\-> ...
-					/* TailQ Deletion. */
-while (!TAILQ_EMPTY(&head)) {
-	n1 = TAILQ_FIRST(&head);
-	TAILQ_REMOVE(&head, n1, entries);
-	free(n1);
-}
-					/* Faster TailQ Deletion. */
-n1 = TAILQ_FIRST(&head);
-while (n1 != NULL) {
-	n2 = TAILQ_NEXT(n1, entries);
-	free(n1);
-	n1 = n2;
-}
-
-TAILQ_INIT(&head);
-.Ed
+.Pp
+See the EXAMPLES section below for an example program using a tail queue.
 .Ss Circular queues
 A circular queue is headed by a structure defined by the
 .Nm CIRCLEQ_HEAD
@@ -1462,6 +1408,63 @@ while (n1 != (void *)&head) {
 
 CIRCLEQ_INIT(&head);
 .Ed
+.Sh EXAMPLES
+.Ss Tail queue example
+.Bd -literal
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/queue.h>
+
+struct entry {
+    int data;
+    TAILQ_ENTRY(entry) entries;             /* Tail queue. */
+};
+
+TAILQ_HEAD(tailhead, entry);
+
+int
+main(void)
+{
+    struct entry    *n1, *n2, *n3, *np;
+    struct tailhead head;                   /* Tail queue head. */
+    int     i;
+
+    TAILQ_INIT(&head);                      /* Initialize the queue. */
+
+    n1 = malloc(sizeof(struct entry));      /* Insert at the head. */
+    TAILQ_INSERT_HEAD(&head, n1, entries);
+
+    n1 = malloc(sizeof(struct entry));      /* Insert at the tail. */
+    TAILQ_INSERT_TAIL(&head, n1, entries);
+
+    n2 = malloc(sizeof(struct entry));      /* Insert after. */
+    TAILQ_INSERT_AFTER(&head, n1, n2, entries);
+
+    n3 = malloc(sizeof(struct entry));      /* Insert before. */
+    TAILQ_INSERT_BEFORE(n2, n3, entries);
+
+    TAILQ_REMOVE(&head, n2, entries);       /* Deletion. */
+    free(n2);
+                                            /* Forward traversal. */
+    i = 0;
+    TAILQ_FOREACH(np, &head, entries)
+        np->data = i++;
+                                            /* Reverse traversal. */
+    TAILQ_FOREACH_REVERSE(np, &head, tailhead, entries)
+        printf("%i\en", np->data);
+                                            /* TailQ Deletion. */
+    n1 = TAILQ_FIRST(&head);
+    while (n1 != NULL) {
+        n2 = TAILQ_NEXT(n1, entries);
+        free(n1);
+        n1 = n2;
+    }
+    TAILQ_INIT(&head);
+
+    exit(EXIT_SUCCESS);
+}
+.Ed
 .Sh CONFORMING TO
 Not in POSIX.1, POSIX.1-2001 or POSIX.1-2008.
 Present on the BSDs.
Signature · 1 line
2.28.0
#1 lore raw
Quoted 1 line · Alejandro Colomar

I thought about having queue.h with an overview of all the different

I meant queue.3 (instead of queue.h).
However, thinking about it,
if we strip if from the details about all of the macros, it might be better as queue.7.

#2 lore raw
In reply to Alejandro Colomar

Hello Alex:

Quoted 7 lines · Alejandro Colomar

I added the EXAMPLES section.
The examples in this page are incomplete
(you can't copy&paste&compile&run).
I fixed the one about TAILQ first,
and the rest should follow.

I have not (yet) applied this patch, because...

Quoted 5 lines

---

Hi Michael,

I think this page needs a big overhaul.

... you are probably right. (And thank you for thinking about the big picture.)

As you are probably aware, the page was essentially lifted from BSD, and lightly edited, and this accounts for many oddities by comparison with other pages.

Quoted 2 lines

First of all, it's a very big page,
where it's a bit difficult to go to the subsection you want.

Agreed.

Quoted 2 lines

Then, the examples are incomplete.
And also, the language of the page is weird.

Yes, there are some rather strange pieces in the page. Just now, I noticed statements about % code size increase, etc, which I'm sure were not measured on Linux (and in any case, such numbers are prone to change, and don't belong in a manual page).

Quoted 11 lines

I thought about having queue.h with an overview of all the different data structures, and the differences about them.

And then separate pages for each data structure:
slist.3, list.3,
stailq.3, tailq.3,
simpleq.3 (which right now isn't documented),
and circleq.3
with details about each macro and a complete example program.

Your thoughts?

The above sounds about right to me. I'd happily accept patches to do that, if you want to work on this.

One thing I'd ask though. Unlike almost every page in man-pages, this page uses mandoc mark-up (rather than "man"). This was a matter of the history, where at some point I refreshed the page from BSD, and decided to retain the mandoc markup,so that if a refresh was ever again done, the diff would be easy to comprehend. If you do decide to do this work, I think it would be desirable
to switch to "man" markup. Sound okay?

Replying to your other mail:

Quoted 5 lines · Alejandro Colomar
Quoted 1 line · Alejandro Colomar

I thought about having queue.h with an overview of all the different

I meant queue.3 (instead of queue.h).

Okay.

Quoted 3 lines

However, thinking about it,
if we strip if from the details about all of the macros, it might be better as queue.7.

Let's leave it as queue.3 for the moment. If it makes sense, we can easily switch it later, as the final step.

Thanks,

Michael

Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
#3 lore raw
Quoted 9 lines · Michael Kerrisk (man-pages)

Hello Alex:

Quoted 6 lines · Alejandro Colomar

I added the EXAMPLES section.
The examples in this page are incomplete
(you can't copy&paste&compile&run).
I fixed the one about TAILQ first,
and the rest should follow.

Quoted 3 lines
Quoted 1 line

I have not (yet) applied this patch, because...

Hi Michael,

I thought that we could do it in the following steps:

1) Fix the current page:
- Complete examples
- Use standard sections (such as EXAMPLES)
2) Move the code from this page to new separate pages
3) Fix the code in all of those pages to use "man" macros

This way, the history can be easily followed in git, instead of having a few commits breaking everything.

Also, I think this way it might be easier,
and the improvements (such as better examples)
can be seen from the beginning.
Part 1 could be applied directly,
while parts 2 & 3 should be applied at once.

If the change was done abruptly, you couldn't apply any commits until all of the work is finished
(otherwise, you would have broken pages).

So I think this patch can be applied as part of this change.

Cheers,

Alex

Quoted 19 lines
Quoted 6 lines

---

Hi Michael,

I think this page needs a big overhaul.

... you are probably right. (And thank you for thinking about the big picture.)

As you are probably aware, the page was essentially lifted from BSD, and lightly edited, and this accounts for many oddities by comparison with other pages.

Quoted 2 lines

First of all, it's a very big page,
where it's a bit difficult to go to the subsection you want.

Agreed.

Quoted 7 lines
Quoted 2 lines

Then, the examples are incomplete.
And also, the language of the page is weird.

Yes, there are some rather strange pieces in the page. Just now, I noticed statements about % code size increase, etc, which I'm sure were not measured on Linux (and in any case, such numbers are prone to change, and don't belong in a manual page).

Agreed.

Quoted 11 lines
Quoted 11 lines

I thought about having queue.h with an overview of all the different data structures, and the differences about them.

And then separate pages for each data structure:
slist.3, list.3,
stailq.3, tailq.3,
simpleq.3 (which right now isn't documented),
and circleq.3
with details about each macro and a complete example program.

Quoted 4 lines
Quoted 1 line

Your thoughts?

The above sounds about right to me. I'd happily accept patches to do that, if you want to work on this.

:-)

Quoted 9 lines

One thing I'd ask though. Unlike almost every page in man-pages, this page uses mandoc mark-up (rather than "man"). This was a matter of the history, where at some point I refreshed the page from BSD, and decided to retain the mandoc markup,so that if a refresh was ever again done, the diff would be easy to comprehend. If you do decide to do this work, I think it would be desirable
to switch to "man" markup. Sound okay?

Yes.

Quoted 10 lines

Replying to your other mail:

Quoted 5 lines · Alejandro Colomar
Quoted 1 line · Alejandro Colomar

I thought about having queue.h with an overview of all the different

I meant queue.3 (instead of queue.h).

Quoted 8 lines

Okay.

Quoted 3 lines

However, thinking about it,
if we strip if from the details about all of the macros, it might be better as queue.7.

Let's leave it as queue.3 for the moment. If it makes sense, we can easily switch it later, as the final step.

Agree.

Quoted 5 lines

Thanks,

Michael

#4 lore raw

Hello Alex,

Quoted 36 lines · Alejandro Colomar
Quoted 9 lines · Michael Kerrisk (man-pages)

Hello Alex:

Quoted 6 lines · Alejandro Colomar

I added the EXAMPLES section.
The examples in this page are incomplete
(you can't copy&paste&compile&run).
I fixed the one about TAILQ first,
and the rest should follow.

Quoted 3 lines
Quoted 1 line

I have not (yet) applied this patch, because...

Hi Michael,

I thought that we could do it in the following steps:

1) Fix the current page:
- Complete examples
- Use standard sections (such as EXAMPLES)
2) Move the code from this page to new separate pages
3) Fix the code in all of those pages to use "man" macros

This way, the history can be easily followed in git, instead of having a few commits breaking everything.

Also, I think this way it might be easier,
and the improvements (such as better examples)
can be seen from the beginning.
Part 1 could be applied directly,
while parts 2 & 3 should be applied at once.

Quoted 5 lines

If the change was done abruptly, you couldn't apply any commits until all of the work is finished
(otherwise, you would have broken pages).

So I think this patch can be applied as part of this change.

Thanks for the excellent clarification. Patch applied!

Cheers,

Michael

Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
#5 lore raw
In reply to Alejandro Colomar
Quoted 7 lines · Alejandro Colomar via Libc-alpha

I think this page needs a big overhaul.

First of all, it's a very big page,
where it's a bit difficult to go to the subsection you want. Then, the examples are incomplete.
And also, the language of the page is weird.

<sys/queue.h> was, IIUC, originally an implementation detail of the original BSD kernel, not intended for use elsewhere. Elsewhere started using it anyway, and that's why glibc has it; there was, at one time, enough user space software that assumed its existence to make a compatibility implementation worthwhile. But I don't think its use should be encouraged in new software, and in fact I'm not sure it should be documented at all.

zw

#6 lore raw

Hi Zack,

Quoted 10 lines · Zack Weinberg
Quoted 7 lines · Alejandro Colomar via Libc-alpha

I think this page needs a big overhaul.

First of all, it's a very big page,
where it's a bit difficult to go to the subsection you want. Then, the examples are incomplete.
And also, the language of the page is weird.

Quoted 7 lines

<sys/queue.h> was, IIUC, originally an implementation detail of the original BSD kernel, not intended for use elsewhere. Elsewhere started using it anyway, and that's why glibc has it; there was, at one time, enough user space software that assumed its existence to make a compatibility implementation worthwhile. But I don't think its use should be encouraged in new software, and in fact I'm not sure it should be documented at all.

Thanks for the input.

From my perspective, not documenting something is a poor way of discouraging the use of that something. Instead, some people just use it badly. I've no problem with adding a note discouraging the use of the APIs, if that's the rough consensus, though.

Thanks,

Michael

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