ccca30c230
Various pages: srcfix: Remove redundant .PP
...
.PP are redundant just after .SH or .SS.
Remove them.
$ find man? -type f \
|xargs sed -i '/^\.S[HS]/{n;/\.PP/d}';
Plus a couple manual edits.
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2021-01-10 09:15:48 +01:00
dc9cadc1c2
Revert "stailq.3, utmp.5, time_namespaces.7: srcfix: remove redundant .PP"
...
Do this in order to apply a better patch from Alex Colomar.
This reverts commit f7fc28f97a
2021-01-10 09:15:12 +01:00
f7fc28f97a
stailq.3, utmp.5, time_namespaces.7: srcfix: remove redundant .PP
...
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2021-01-10 08:59:28 +01:00
2ddebe1a77
circleq.3, list.3, slist.3, stailq.3, queue.7: tfix (Oxford comma)
...
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2021-01-09 10:41:55 +01:00
554afbe862
circleq.3, list.3, slist.3, stailq.3, tailq.3: Improve readability, especially in SYNOPSIS
...
- Group macros by kinds.
- Align so that it's easiest to distinguish differences
between related macros.
(Align all continuations for consistency on PDF.)
- Fix minor typos.
- Remove redundant text:
'The macro xxx() ...':
The first paragraph already says that these are macros.
'circular|tail|... queue':
Don't need to repeat every time.
Generic text makes it easier to spot the differences.
- Fit lines into 78 columns.
- Reorder descriptions to match SYNOPSIS,
and add subsections to DESCRIPTION.
- srcfix: fix a few semantic newlines.
I noticed a bug which should be fixed next:
CIRCLEQ_LOOP_*() return a 'struct TYPE *'.
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2021-01-06 13:46:44 +01:00
511bb71b0c
Various pages: Further clean-ups after "bring more whitespace consistency in SYNOPSIS"
...
Yet more clean-ups after commit
15d6565317
2021-01-03 13:09:36 +01:00
c5127de6ff
stailq.3: ffix
...
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-12-23 14:23:39 +01:00
f52cb55283
list.3, slist.3, stailq.3, tailq.3: tfix
...
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-12-23 14:20:50 +01:00
c2e81ff964
seccomp.2, circleq.3, list.3, malloc_hook.3, slist.3, stailq.3, tailq.3, ip.7, unix.7: tfix
...
Remove "." at the end of sentence fragments/short single sentences
in comments.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-12-23 14:17:30 +01:00
c89a843c28
stailq.3: SEE ALSO: Add insque(3), queue(7)
...
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-10-26 06:49:31 +01:00
9484d926ff
stailq.3, tailq.3: Minor fix: replace ".Ss" lines with ".PP"
...
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-10-25 12:31:25 +01:00
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
13e59b9684
circleq.3, list.3, slist.3, stailq.3, tailq.3: Use the 'struct' keyword when appropriate
...
This helps differentiate 'TYPE' in some arguments from
'struct TYPE *var' in others, and is technically more correct.
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-10-25 12:15:47 +01:00
b1db934051
circleq.3, list.3, slist.3, stailq.3: Fix return type of macros
...
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-10-25 10:34:07 +01:00
906766f590
stailq.3: Add remaining details to complete the page
...
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:38 +01:00
00ba3a085e
stailq.3: ffix: Use man markup
...
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:33 +01:00
fc89a378d6
stailq.3: Copy and adapt code from queue.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:28 +01:00
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
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
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
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
27f9e01adf
stailq.3: New page that will hold the (stailq) contents of queue.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:03 +01:00
Alejandro Colomar