LDP
/
man-pages
mirror of https://github.com/mkerrisk/man-pages
0
1
Fork 0
Code Releases Activity
21,697 Commits 1 Branch 197 Tags 93 MiB
Commit Graph

77 Commits

Author SHA1 Message Date
Alejandro Colomar d9a0505f71 queue.3, queue.7: Move queue.3 to queue.7 
After forking slist.3, list.3, tailq.3, stailq.3 & circleq.3
in the previous commits,
this page no longer belongs in Section 3 of the manual pages.

According to its contents, the most suitable section is Section 7.

Because of legacy reasons, a link queue.3 -> queue(7)
would be appropriate.

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 22:17:05 +01:00
Michael Kerrisk df10ec359a circleq.3, list.3, queue.3, slist.3, stailq.3, tailq.3: Minor grammar fix 
Don't hyphenate after adjective ending in "ly". See, for example:
https://www.dragoman.ist/compound-modifiers-with-words-ending-in-ly/
https://www.merriam-webster.com/words-at-play/6-common-hypercorrections-and-how-to-avoid-them/between-you-and-i

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 12:23:43 +01:00
Michael Kerrisk d03e886304 queue.3: wfix 
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 12:11:25 +01:00
Alejandro Colomar d43abf2771 queue.3: Fix & update after forking circleq.3, list.3, slist.3, stailq.3 & tailq.3 
- ffix: Use man markup
- Remove specific notes about code size increase
  and execution time increase,
  as they were (at least) inaccurate.
  Instead, a generic note has been added.
- Structure the text into subsections.
- Remove sections that were empty after the forks.
- Clearly relate macro names (SLIST, TAILQ, ...)
  to a human readable name of which data structure
  they implement.

Reported-by: Michael Kerrisk <mtk.manpages@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 12:09:38 +01:00
Alejandro Colomar 90a60096ba queue.3: Add self to copyright notice 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 12:09:27 +01:00
Alejandro Colomar bfc09cdd9a queue.3: SEE ALSO: Add tailq(3) 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 10:42:56 +01:00
Alejandro Colomar 7b8d4bbf32 queue.3, tailq.3: EXAMPLES: Move code from queue.3 to tailq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 10:42:31 +01:00
Alejandro Colomar 32d12807a8 queue.3, tailq.3: DESCRIPTION: Move code from queue.3 to tailq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 10:42:26 +01:00
Alejandro Colomar af64b7276f queue.3, tailq.3: SYNOPSIS: Move code from queue.3 to tailq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 10:42:21 +01:00
Alejandro Colomar f8f346bc7f queue.3, tailq.3: NAME: Move code from queue.3 to tailq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 10:42:16 +01:00
Alejandro Colomar 9fed47b65d queue.3: SEE ALSO: Add stailq(3) 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 09:49:52 +01:00
Alejandro Colomar d47b080534 queue.3, stailq.3: EXAMPLES: Move stailq example from queue.3 to stailq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 09:49:22 +01:00
Alejandro Colomar cdba777fd5 queue.3, stailq.3: DESCRIPTION: Move stailq specific code from queue.3 to stailq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 09:49:18 +01:00
Alejandro Colomar 17ef240dbf queue.3, stailq.3: SYNOPSIS: Move code from queue.3 to stailq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 09:49:13 +01:00
Alejandro Colomar e029607481 queue.3, stailq.3: NAME: Move code from queue.3 to stailq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-25 09:49:08 +01:00
Alejandro Colomar 14992403c8 queue.3: SEE ALSO: Add circleq(3) 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-23 18:13:47 +02:00
Alejandro Colomar 68ed526e29 queue.3: ffix 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-23 18:13:11 +02:00
Alejandro Colomar 8306d5cb87 circleq.3, queue.3: EXAMPLES: Move circleq example program from queue.3 to circleq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-23 18:13:06 +02:00
Alejandro Colomar 66bb7b4db4 circleq.3, queue.3: DESCRIPTION: Move circleq specific code from queue.3 to circleq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-23 18:13:00 +02:00
Alejandro Colomar 8ad9d90ccf circleq.3, queue.3: SYNOPSIS: Move code from queue.3 to circleq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-23 18:12:56 +02:00
Alejandro Colomar 90502e3efa circleq.3, queue.3: NAME: Move code from queue-3 to circleq.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-23 18:12:50 +02:00
Alejandro Colomar 31e6e673b1 queue.3: Sort alphabetically 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-23 18:11:49 +02:00
Alejandro Colomar c49f19edef queue.3: SEE ALSO: Add slist(3) 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-22 19:31:37 +02:00
Alejandro Colomar 21b0363fd0 queue.3, slist.3: EXAMPLES: Move example program from queue.3 to slist.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-22 19:31:07 +02:00
Alejandro Colomar 8d526f6322 queue.3, slist.3: DESCRIPTION: Move slist specific code from queue.3 to slist.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-22 19:30:54 +02:00
Alejandro Colomar 36eac952da queue.3, slist.3: SYNOPSIS: Move code from queue.3 to list.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-22 19:30:49 +02:00
Alejandro Colomar 96234e9ef8 queue.3, slist.3: NAME: Move code from queue.3 to slist.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-22 19:30:42 +02:00
Alejandro Colomar 4c95e2afae queue.3: SEE ALSO: Add list(3) 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-21 06:35:58 +02:00
Alejandro Colomar be7973e6b1 list.3, queue.3: EXAMPLES: Move example program from queue.3 to list.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-21 06:35:20 +02:00
Alejandro Colomar 13514abe53 list.3, queue.3: DESCRIPTION: Move list specific code from queue.3 to list.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-21 06:35:12 +02:00
Alejandro Colomar 6ac2278707 list.3, queue.3: SYNOPSIS: Move code from queue.3 to list.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-21 06:35:04 +02:00
Alejandro Colomar 71b0fc4a75 list.3, queue.3: NAME: Move code from queue.3 to list.3 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-21 06:34:57 +02:00
Alejandro Colomar 740656b855 queue.3: stailq: Complete example 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-17 12:26:00 +02:00
Alejandro Colomar 7ef4fb8fcf queue.3: list: Complete example 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-15 20:49:50 +02:00
Alejandro Colomar 46b0a9d69c queue.3: circleq: Complete example 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-13 17:36:17 +02:00
Alejandro Colomar 5158e8ee72 queue.3: slist: Complete example 
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-11 18:04:17 +02:00
Alejandro Colomar b3617b75f9 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.

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-10-11 14:22:20 +02:00
Michael Kerrisk b49ea62e96 queue.3: ffix 
Reported-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-08-24 17:06:59 +02:00
Michael Kerrisk c3a4e4fe36 queue.3: Minor formatting fixes for Alejandro Colomar's patch 
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-08-24 09:02:54 +02:00
Alejandro Colomar cbade5057d queue.3: Document CIRCLEQ_* macros 
I run ``sudo make`` and then visualized the man page with
``man 3 queue``, and the contents looked good.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-08-24 08:50:23 +02:00
Alejandro Colomar 1d2e2ecda7 queue.3: Remove wrong code from example 
There was code containing ``CIRCLEQ_*`` in the examples for ``TAILQ_*``.  It was introduced by accident in commit ``041abbe``.

From 0c9dfbe9b1ce1130e9a92d1a16fbecd4a08bbe29 Mon Sep 17 00:00:00 2001
From: Alejandro Colomar <colomar.6.4.3@gmail.com>
Date: Wed, 12 Aug 2020 09:11:27 +0200
Subject: [PATCH] queue.3: Remove wrong code from example

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-08-13 09:27:07 +02:00
Alejandro Colomar 6253e7d6ec queue.3: Comment out text for functions not in glibc (related: 6559169cac) 
===========
DESCRIPTION
===========

I'm documenting ``CIRCLEQ_*`` macros in queue.3.  While writing
this, I noticed that the documentation for some types of
queues/lists talked about swapping contents of two lists, but only
for some of them.  I then found that those macros (``*_SWAP``)
don't exist in my system (Debian), but exist in BSD, and I also
found that a previous commit (6559169cac) commented out a lot of
the *_SWAP macros documentation, but not all, and the reason was
that they were not present on glibc.

I checked that I didn't have any of the *_SWAP macros on my glibc,
so I think this is probably that the commit simply forgot to
comment some of
them.

=======
TESTING
=======

I did ``sudo make`` and then visualized the man page with
``man 3 queue``, and the changes looked good.

I also noticed that the subsection ``Tail queue example`` contents
were wrong, as they contained calls to CIRCLEQ_* macros.  I will
address that in a future patch, before I submit the patch
documenting CIRCLEQ_*.

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2020-08-04 14:48:03 +02:00
Michael Kerrisk b96315d884 queue.3: ffix 
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2017-08-25 20:54:52 +02:00
Michael Kerrisk 67f2fdfef6 queue.3: wfix 
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2017-08-20 10:27:58 +02:00
Michael Kerrisk 413579fc3b queue.3: SEE ALSO: add insque(3) 
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2017-04-24 21:16:38 +02:00
Dr. Tobias Quathamer 45a2419dac queue.3: Remove double CONFORMING TO section 
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2016-02-15 16:16:59 +01:00
Michael Kerrisk 041abbe3ee queue.3: wfix 
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2015-07-24 09:32:10 +02:00
Michael Kerrisk 8cc4d07100 Removed trailing white space at end of lines 2015-07-23 16:15:22 +02:00
Michael Kerrisk ed69ec5292 queue.3: srcfix: Add license marker tags 
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2015-07-16 19:29:35 +02:00
Michael Kerrisk 43e48f9eab queue.3: Use real hyphens in code samples 
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
 2015-07-16 19:29:35 +02:00