]> git.ipfire.org Git - thirdparty/man-pages.git/log
thirdparty/man-pages.git
2 years agoman2/: use consistent closed interval notation for value ranges
Brian Inglis [Wed, 8 Feb 2023 20:27:25 +0000 (13:27 -0700)] 
man2/: use consistent closed interval notation for value ranges

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoPA_CHAR.3const, PA_DOUBLE.3const, PA_FLAG_LONG.3const, PA_FLAG_LONG_DOUBLE.3const...
Alex Colomar [Mon, 19 Sep 2022 16:15:05 +0000 (18:15 +0200)] 
PA_CHAR.3const, PA_DOUBLE.3const, PA_FLAG_LONG.3const, PA_FLAG_LONG_DOUBLE.3const, PA_FLAG_LONG_LONG.3const, PA_FLAG_PTR.3const, PA_FLAG_SHORT.3const, PA_FLOAT.3const, PA_INT.3const, PA_LAST.3const, PA_POINTER.3const, PA_STRING.3const, PA_WCHAR.3const, PA_WSTRING.3const: Add links to printf.h(3head)

Cc: Walter Harms <wharms@bfs.de>
Cc: <Radisson97@gmx.de>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: <libc-alpha@sourceware.org>
Signed-off-by: Alex Colomar <alx.manpages@gmail.com>
2 years agoprintf_arginfo_size_function.3type, printf_function.3type, printf_info.3type, printf_...
Alex Colomar [Mon, 19 Sep 2022 16:14:49 +0000 (18:14 +0200)] 
printf_arginfo_size_function.3type, printf_function.3type, printf_info.3type, printf_va_arg_function.3type: Add links to printf.h(3head)

Cc: Walter Harms <wharms@bfs.de>
Cc: <Radisson97@gmx.de>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: <libc-alpha@sourceware.org>
Signed-off-by: Alex Colomar <alx.manpages@gmail.com>
2 years agoregister_printf_specifier.3, register_printf_modifier.3, register_printf_type.3:...
Alex Colomar [Sun, 18 Sep 2022 22:12:28 +0000 (00:12 +0200)] 
register_printf_specifier.3, register_printf_modifier.3, register_printf_type.3: Add links to printf.h(3head)

Cc: Walter Harms <wharms@bfs.de>
Cc: <Radisson97@gmx.de>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: <libc-alpha@sourceware.org>
Signed-off-by: Alex Colomar <alx.manpages@gmail.com>
2 years agoprintf.3head: Document functions for customizing printf(3)-like functions
Alex Colomar [Sun, 18 Sep 2022 22:12:28 +0000 (00:12 +0200)] 
printf.3head: Document functions for customizing printf(3)-like functions

Suggested-by: Walter Harms <wharms@bfs.de>
Cc: <Radisson97@gmx.de>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: <libc-alpha@sourceware.org>
Signed-off-by: Alex Colomar <alx.manpages@gmail.com>
2 years agounits.7: srcfix (\(mc -> \[mc])
G. Branden Robinson [Thu, 9 Feb 2023 18:12:10 +0000 (12:12 -0600)] 
units.7: srcfix (\(mc -> \[mc])

Use correct *roff special character for micro sign.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoadjtimex.2: srcfix
G. Branden Robinson [Thu, 9 Feb 2023 18:11:50 +0000 (12:11 -0600)] 
adjtimex.2: srcfix

* Stop manipulating adjustment and hyphenation around a table.
* These could be safely done within the text block, but even that is not
  necessary, since what is in the next block is a single word, so no
  adjustment will take place, and to prevent hyphenation of a single
  word, \% is cheap and straightforward.  So do that.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agolocaledef.1: srcfix
G. Branden Robinson [Thu, 9 Feb 2023 18:11:00 +0000 (12:11 -0600)] 
localedef.1: srcfix

Break input lines after commas and semicolons.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agolocaledef.1: ffix
G. Branden Robinson [Thu, 9 Feb 2023 18:10:52 +0000 (12:10 -0600)] 
localedef.1: ffix

Rewrite synopses to use groff man(7) `SY`/`YS` extension macros.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agolocaledef.1: ffix
G. Branden Robinson [Thu, 9 Feb 2023 18:10:45 +0000 (12:10 -0600)] 
localedef.1: ffix

Stop manipulating adjustment and hyphenation.

Forcibly re-enabling adjustment to both margins after the synopsis does
not respect user configuration of adjustment.  There _is_ a portable way
to save the adjustment mode, via the .j register and a copy of it, but
doing so requires even more usage of low-level requests that are
discouraged in man page writing.

The latter is incorrect for use with groff(1) since '.hy' does not
restore the previous hyphenation mode but sets it to 1, which is not
appropriate for the English-language hyphenation patterns groff uses.
(Also, AT&T man(7) used a hyphenation mode of 14.)

Neither of these requests is respectful of user configuration of
adjustment or hyphenation enablement.  Features in the forthcoming
groff 1.23 will make these easier for users to manipulate to their
preference.

(mandoc(1) does not support configurable adjustment or hyphenation, so
all of these requests are no-ops for it.)

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agovdso.7: fix deadlinks to Linux Documentation/
наб [Fri, 10 Feb 2023 01:30:16 +0000 (02:30 +0100)] 
vdso.7: fix deadlinks to Linux Documentation/

Respectively:
commit dc7a12bdfccd94c31f79e294f16f7549bd411b49 ("docs: arm: convert
docs to ReST and rename to *.rst")
commit db9a0975a20c1f21c108b9d44545792d790593e4 ("docs: ia64: convert to
ReST")
commit e77e9187ae1caf2d83dd5e7f0c1466254b644a4c ("docs: parisc: convert
to ReST and add to documentation body")

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agotimes.2: ffix
G. Branden Robinson [Thu, 9 Feb 2023 18:10:36 +0000 (12:10 -0600)] 
times.2: ffix

Use \[lq] and \[rq] special characters for prose quotation marks.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agotimes.2: srcfix
G. Branden Robinson [Thu, 9 Feb 2023 18:10:29 +0000 (12:10 -0600)] 
times.2: srcfix

Break input lines after commas.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoquotactl.2: ffix
G. Branden Robinson [Thu, 9 Feb 2023 18:10:11 +0000 (12:10 -0600)] 
quotactl.2: ffix

Use \- for minus sign instead of - (hyphen), producing better typography
on typesetting devices and Unicode terminals.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoclose_range.2: srcfix (~ -> \[ti])
G. Branden Robinson [Thu, 9 Feb 2023 18:10:04 +0000 (12:10 -0600)] 
close_range.2: srcfix (~ -> \[ti])

Use correct *roff special character for ("ASCII") tilde.

There are other occurrences in bpf-helpers.7, but those will have to
await improvement of the tool that generates man(7) from the source
language.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoman*/: srcfix (^ -> \[ha])
G. Branden Robinson [Thu, 9 Feb 2023 18:09:50 +0000 (12:09 -0600)] 
man*/: srcfix (^ -> \[ha])

Use correct *roff special character for hat/caret/circumflex accent.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoioctl_fat.2: srcfix
G. Branden Robinson [Thu, 9 Feb 2023 18:09:43 +0000 (12:09 -0600)] 
ioctl_fat.2: srcfix

Remove unportable hack to put a dot at the beginning of an input line.
Use the idiomatic means of doing this instead: the roff dummy character
escape sequence.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoprctl.2: srcfix
G. Branden Robinson [Thu, 9 Feb 2023 18:09:35 +0000 (12:09 -0600)] 
prctl.2: srcfix

Remove spurious escaping of '.' where it cannot be interpreted as a roff
control character.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agosched.7: srcfix
G. Branden Robinson [Thu, 9 Feb 2023 18:09:07 +0000 (12:09 -0600)] 
sched.7: srcfix

Fix warnings from formatter.

troff:./man7/sched.7:989: warning [p 10, 2.7i]: cannot adjust line
troff:./man7/sched.7:990: warning [p 10, 2.8i]: cannot adjust line

Add hyphenless break points to file names, but also suppress hyphenation
to reduce copy-and-paste frustration.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoman2/: srcfix (hyphens used as C operators)
G. Branden Robinson [Thu, 9 Feb 2023 18:08:59 +0000 (12:08 -0600)] 
man2/: srcfix (hyphens used as C operators)

Escape hyphens used as parts of C `->` operators.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agogetrandom.2: Change limit to use IEC multiple symbol
Brian Inglis [Wed, 8 Feb 2023 20:27:31 +0000 (13:27 -0700)] 
getrandom.2: Change limit to use IEC multiple symbol

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoreboot.2: Show BCD dates in hex not decimal
Brian Inglis [Wed, 8 Feb 2023 20:27:27 +0000 (13:27 -0700)] 
reboot.2: Show BCD dates in hex not decimal

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agospu_run.2: Fix example comment status code or-ed value
Brian Inglis [Wed, 8 Feb 2023 20:27:24 +0000 (13:27 -0700)] 
spu_run.2: Fix example comment status code or-ed value

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoshmget.2: Fix limit units prefix symbol from SI to IEC
Brian Inglis [Wed, 8 Feb 2023 20:27:23 +0000 (13:27 -0700)] 
shmget.2: Fix limit units prefix symbol from SI to IEC

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoperf_event_open.2: Add missing variable name
Namhyung Kim [Tue, 7 Feb 2023 01:50:29 +0000 (17:50 -0800)] 
perf_event_open.2: Add missing variable name

Signed-off-by: Namhyung Kim <namhyung@kernel.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agopersistent-keyring.7: wfix
Jakub Wilk [Tue, 7 Feb 2023 21:40:04 +0000 (22:40 +0100)] 
persistent-keyring.7: wfix

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agounits.7: Add break points in URI
Alejandro Colomar [Mon, 6 Feb 2023 00:15:19 +0000 (01:15 +0100)] 
units.7: Add break points in URI

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agounits.7: Fix escapes (\-) in URI
Alejandro Colomar [Mon, 6 Feb 2023 00:14:12 +0000 (01:14 +0100)] 
units.7: Fix escapes (\-) in URI

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agounits.7: Use \[mc] instead of \(mc
Alejandro Colomar [Sun, 5 Feb 2023 22:19:36 +0000 (23:19 +0100)] 
units.7: Use \[mc] instead of \(mc

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoprctl.2, man.7: Use \[ga] instead of \(ga
Alejandro Colomar [Sun, 5 Feb 2023 22:18:43 +0000 (23:18 +0100)] 
prctl.2, man.7: Use \[ga] instead of \(ga

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoprctl.2: Use \[cq] instead of \(cq
Alejandro Colomar [Sun, 5 Feb 2023 22:16:48 +0000 (23:16 +0100)] 
prctl.2: Use \[cq] instead of \(cq

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoprctl.2: Use \[oq] instead of \(oq
Alejandro Colomar [Sun, 5 Feb 2023 22:16:27 +0000 (23:16 +0100)] 
prctl.2: Use \[oq] instead of \(oq

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Use \[bu] instead of \(bu
Alejandro Colomar [Sun, 5 Feb 2023 22:14:38 +0000 (23:14 +0100)] 
Many pages: Use \[bu] instead of \(bu

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoVarious pages: Use \[rq] instead of \(rq
Alejandro Colomar [Sun, 5 Feb 2023 22:04:52 +0000 (23:04 +0100)] 
Various pages: Use \[rq] instead of \(rq

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoVarious pages: Use \[lq] instead of \(lq
Alejandro Colomar [Sun, 5 Feb 2023 22:04:23 +0000 (23:04 +0100)] 
Various pages: Use \[lq] instead of \(lq

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Use \[ha] instead of \(ha
Alejandro Colomar [Sun, 5 Feb 2023 22:03:36 +0000 (23:03 +0100)] 
Many pages: Use \[ha] instead of \(ha

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Use \[ti] instead of \(ti
Alejandro Colomar [Sun, 5 Feb 2023 22:02:42 +0000 (23:02 +0100)] 
Many pages: Use \[ti] instead of \(ti

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Use \[em] instead of \(em
Alejandro Colomar [Sun, 5 Feb 2023 22:02:09 +0000 (23:02 +0100)] 
Many pages: Use \[em] instead of \(em

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Use \[en] instead of \(en
Alejandro Colomar [Sun, 5 Feb 2023 22:01:29 +0000 (23:01 +0100)] 
Many pages: Use \[en] instead of \(en

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoman-pages.7: Recommend using \[..] instead of \(.. escapes
Alejandro Colomar [Sun, 5 Feb 2023 21:59:22 +0000 (22:59 +0100)] 
man-pages.7: Recommend using \[..] instead of \(.. escapes

They are more readable.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoEOF.3const: ffix
Alejandro Colomar [Sun, 5 Feb 2023 16:08:00 +0000 (17:08 +0100)] 
EOF.3const: ffix

Reported-by: наб <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agotimespec.3type: tv_nsec is impl-def-type, glibc llong not a bug
наб [Mon, 30 Jan 2023 18:38:35 +0000 (19:38 +0100)] 
timespec.3type: tv_nsec is impl-def-type, glibc llong not a bug

n3091 accepts n3066, making it part of the next working draft and C23:
  https://www.open-std.org/jtc1/sc22/wg14/www/docs/n3091.doc

Update timespec.3type appropriately, largely mirroring my paper.

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Use \[dq] instead of \(dq
Alejandro Colomar [Sun, 5 Feb 2023 16:03:19 +0000 (17:03 +0100)] 
Many pages: Use \[dq] instead of \(dq

This improves readability in the source code, since it delimits where
the escape sequence ends.

Cc: наб <nabijaczleweli@nabijaczleweli.xyz>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Brian Inglis <Brian.Inglis@Shaw.ca>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Use \[aq] instead of \(aq
Alejandro Colomar [Sun, 5 Feb 2023 16:03:19 +0000 (17:03 +0100)] 
Many pages: Use \[aq] instead of \(aq

This improves readability in the source code, since it delimits where
the escape sequence ends.

Cc: наб <nabijaczleweli@nabijaczleweli.xyz>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Brian Inglis <Brian.Inglis@Shaw.ca>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Use lowercase for 'glibc'
Alejandro Colomar [Sun, 5 Feb 2023 15:57:58 +0000 (16:57 +0100)] 
Many pages: Use lowercase for 'glibc'

It's a proper noun, whose original letter case should be respected.
glibc's own documentation uses always lowercase; let's do the same here.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agosscanf.3: BUGS: Document the UB in some conversion specifiers
Alejandro Colomar [Sun, 5 Feb 2023 14:36:07 +0000 (15:36 +0100)] 
sscanf.3: BUGS: Document the UB in some conversion specifiers

This is a bug in the standards, but implementation should not follow the
standard in this case.

Link: <https://lore.kernel.org/linux-man/20221208123454.13132-1-abbotti@mev.co.uk/T/#u>
Cc: Ian Abbott <abbotti@mev.co.uk>
Cc: Zack Weinberg <zack@owlfolio.org>
Cc: Joseph Myers <joseph@codesourcery.com>
Cc: Eric Biggers <ebiggers@kernel.org>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agonamespaces.7: ffix
Alejandro Colomar [Sun, 5 Feb 2023 14:32:13 +0000 (15:32 +0100)] 
namespaces.7: ffix

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoregex.3: tfix
Alejandro Colomar [Sun, 5 Feb 2023 14:30:53 +0000 (15:30 +0100)] 
regex.3: tfix

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agocharsets.7: wfix
Alejandro Colomar [Sun, 5 Feb 2023 14:25:40 +0000 (15:25 +0100)] 
charsets.7: wfix

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoperf_event_open.2: Update recent changes
Namhyung Kim [Tue, 17 Jan 2023 08:08:46 +0000 (00:08 -0800)] 
perf_event_open.2: Update recent changes

Add missing perf_event_attr fields, new event codes and sample type.
Also add descriptions for PERF_FORMAT_LOST.

Signed-off-by: Namhyung Kim <namhyung@kernel.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agolandlock.7: tfix
Günther Noack [Wed, 1 Feb 2023 22:42:24 +0000 (23:42 +0100)] 
landlock.7: tfix

Signed-off-by: Günther Noack <gnoack3000@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agolandlock.7: ffix
Günther Noack [Wed, 1 Feb 2023 22:42:23 +0000 (23:42 +0100)] 
landlock.7: ffix

Signed-off-by: Günther Noack <gnoack3000@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agovdso.7: Fix risc-v symbol names.
Elliott Hughes [Mon, 30 Jan 2023 21:46:09 +0000 (21:46 +0000)] 
vdso.7: Fix risc-v symbol names.

The kernel git history says the names have always been "__vdso_" rather
than "__kernel_", so I assume this was a copy & paste mistake from a
different architecture.

Luckily, the path to the kernel source that lets you confirm/deny this
_is_ correct :-)

Signed-off-by: Elliott Hughes <enh@google.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agobpf-helpers.7: Refresh page
Alejandro Colomar [Tue, 31 Jan 2023 11:53:50 +0000 (12:53 +0100)] 
bpf-helpers.7: Refresh page

See commit 19c7f78393f2 ("bpf-helpers.7: Refresh page")

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agointN_t.3type: tfix
Jakub Wilk [Mon, 30 Jan 2023 19:09:41 +0000 (20:09 +0100)] 
intN_t.3type: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agocharsets.7: wfix
Alejandro Colomar [Sun, 29 Jan 2023 19:31:08 +0000 (20:31 +0100)] 
charsets.7: wfix

Several of the languages mentioned are not West Europe.  Some come from
the North, South, or East.

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Cc: Stefan Puiu <stefan.puiu@gmail.com>
Cc: Bernd Petrovitsch <bernd@petrovitsch.priv.at>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agocppcheck.suppress, lint-c.mk: lint-c-cppcheck: Add cppcheck(1) to the C linters
Alejandro Colomar [Thu, 26 Jan 2023 00:06:34 +0000 (01:06 +0100)] 
cppcheck.suppress, lint-c.mk: lint-c-cppcheck: Add cppcheck(1) to the C linters

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agogetdents.2: EXAMPLES: Fix printf() conversion specifier
Alejandro Colomar [Thu, 26 Jan 2023 00:04:18 +0000 (01:04 +0100)] 
getdents.2: EXAMPLES: Fix printf() conversion specifier

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agofopencookie.3: EXAMPLES: Fix memory leak
Alejandro Colomar [Thu, 26 Jan 2023 00:01:31 +0000 (01:01 +0100)] 
fopencookie.3: EXAMPLES: Fix memory leak

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoseccomp_unotify.2: EXAMPLES: tfix
Alejandro Colomar [Thu, 26 Jan 2023 00:01:11 +0000 (01:01 +0100)] 
seccomp_unotify.2: EXAMPLES: tfix

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agogetdate.3: EXAMPLES: Fix printf() conversion specifier
Alejandro Colomar [Wed, 25 Jan 2023 23:58:43 +0000 (00:58 +0100)] 
getdate.3: EXAMPLES: Fix printf() conversion specifier

Fixes: b42296e4 "Various pages: EXAMPLES: Use unsigned types for loop iterators"
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agopthread_setschedparam.3: EXAMPLES: Don't assign unused value
Alejandro Colomar [Wed, 25 Jan 2023 23:24:12 +0000 (00:24 +0100)] 
pthread_setschedparam.3: EXAMPLES: Don't assign unused value

We're not reading the value after it's set.  And I just checked that
that function can't fail for reasonable input.

Reported-by: cppcheck(1)
Reported-by: `make lint-c-cppcheck`
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agotsearch.3: EXAMPLES: Don't else after noreturn
Alejandro Colomar [Wed, 25 Jan 2023 23:14:19 +0000 (00:14 +0100)] 
tsearch.3: EXAMPLES: Don't else after noreturn

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostpncpy.3: EXAMPLES: tfix
Alejandro Colomar [Wed, 25 Jan 2023 23:08:22 +0000 (00:08 +0100)] 
stpncpy.3: EXAMPLES: tfix

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agorpmatch.3: EXAMPLES: Use _DEFAULT_SOURCE instead of _SVID_SOURCE
Alejandro Colomar [Wed, 25 Jan 2023 23:07:41 +0000 (00:07 +0100)] 
rpmatch.3: EXAMPLES: Use _DEFAULT_SOURCE instead of _SVID_SOURCE

_SVID_SOURCE is deprecated.  Show how a program should be written today.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostatic_assert.3: srcfix
Alejandro Colomar [Wed, 25 Jan 2023 23:03:29 +0000 (00:03 +0100)] 
static_assert.3: srcfix

Add missing ." SRC END comment.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agobuild-src.mk: CFLAGS: Add -Wdeclaration-after-statement
Alejandro Colomar [Wed, 25 Jan 2023 23:02:16 +0000 (00:02 +0100)] 
build-src.mk: CFLAGS: Add -Wdeclaration-after-statement

This helps write more readable code, separating variable declarations
from code.  In some cases, when initializing structs, or declaring some
VLAs, we can't follow the rule, so don't make it an error.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoVarious pages: EXAMPLES: Fix -Wdeclaration-after-statement errors
Alejandro Colomar [Wed, 25 Jan 2023 23:00:30 +0000 (00:00 +0100)] 
Various pages: EXAMPLES: Fix -Wdeclaration-after-statement errors

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoVarious pages: wfix
Alejandro Colomar [Sun, 22 Jan 2023 21:40:00 +0000 (22:40 +0100)] 
Various pages: wfix

Fixes: b324e17d3208 ("Many pages: wfix")
Reported-by: Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agogetpid.2: tfix
Alejandro Colomar [Sun, 22 Jan 2023 21:26:04 +0000 (22:26 +0100)] 
getpid.2: tfix

Reported-by: Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years ago_exit.2: tfix
Alejandro Colomar [Sun, 22 Jan 2023 21:23:00 +0000 (22:23 +0100)] 
_exit.2: tfix

Reported-by: Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agottytype.5: ffix
Alejandro Colomar [Sun, 22 Jan 2023 21:17:19 +0000 (22:17 +0100)] 
ttytype.5: ffix

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agouser_namespaces.7: ffix
Alejandro Colomar [Sun, 22 Jan 2023 21:15:17 +0000 (22:15 +0100)] 
user_namespaces.7: ffix

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostring.3: wfix
Alejandro Colomar [Sun, 22 Jan 2023 21:05:31 +0000 (22:05 +0100)] 
string.3: wfix

Use consistent syntax for 'dest' vs 'dst' in string(3).

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agosession-keyring.7: SEE ALSO: refer to PAM(7)
Alejandro Colomar [Sun, 22 Jan 2023 20:58:25 +0000 (21:58 +0100)] 
session-keyring.7: SEE ALSO: refer to PAM(7)

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blaettermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agonfsservctl.2: ffix
Alejandro Colomar [Sun, 22 Jan 2023 20:28:22 +0000 (21:28 +0100)] 
nfsservctl.2: ffix

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: mario.blaettermann@gmail.com
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agosocket.7: tfix
Jan Engelhardt [Sun, 22 Jan 2023 11:20:34 +0000 (12:20 +0100)] 
socket.7: tfix

The .TP macro is followed by exactly one line of definition, and then
multiple lines of flowed explanatory text.  When flowed, the lack of
periods is apparent in sentences.

Signed-off-by: Jan Engelhardt <jengelh@inai.de>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agogetnameinfo.3: SYNOPSIS: Add missing _Nullable qualifiers
Alejandro Colomar [Thu, 19 Jan 2023 18:01:00 +0000 (19:01 +0100)] 
getnameinfo.3: SYNOPSIS: Add missing _Nullable qualifiers

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoroundup.3: New page documenting roundup(3)
Alejandro Colomar [Thu, 19 Jan 2023 13:08:21 +0000 (14:08 +0100)] 
roundup.3: New page documenting roundup(3)

Cc: Paul Eggert <eggert@cs.ucla.edu>
Cc: Wilco Dijkstra <Wilco.Dijkstra@arm.com>
Cc: Adhemerval Zanella <adhemerval.zanella@linaro.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agounits.7: Remove references to NIST
Alejandro Colomar [Sun, 15 Jan 2023 14:51:28 +0000 (15:51 +0100)] 
units.7: Remove references to NIST

The SI brochure is the reference.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agounits.7: Add decimal and binary prefixes
Alejandro Colomar [Sun, 15 Jan 2023 14:47:49 +0000 (15:47 +0100)] 
units.7: Add decimal and binary prefixes

The SI added prefixes for 10^(+-)27 and 30 in 2022.

While updating this, I realized that we were missing Zi and Yi, which
are specified by the SI, I guess since a long time ago.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoprctl.2, proc.5: Document VMA naming
Nick Gregory [Sat, 7 Jan 2023 22:19:49 +0000 (22:19 +0000)] 
prctl.2, proc.5: Document VMA naming

Bring in man page changes from the patch set by Colin Cross, and
document the corresponding virtual names in procfs.

Link: <https://lore.kernel.org/linux-mm/20211019215511.3771969-2-surenb@google.com/>
Signed-off-by: Nick Gregory <nick@nickgregory.me>
Reviewed-by: Suren Baghdasaryan <surenb@google.com>
Cc: Colin Cross <ccross@google.com>
Cc: Kees Cook <keescook@chromium.org>
Cc: Pasha Tatashin <tatashin@google.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agointro.3: ffix
G. Branden Robinson [Sat, 7 Jan 2023 09:55:09 +0000 (03:55 -0600)] 
intro.3: ffix

Set "feature test macros" in italics when introducing it as a technical
term.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agointro.3: srcfix
G. Branden Robinson [Sat, 7 Jan 2023 09:55:00 +0000 (03:55 -0600)] 
intro.3: srcfix

* Break input lines at phrase boundaries more often.
* Break input lines after commas.
* Set multi-word parentheticals on their own input lines.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agolibc.7: ffix
G. Branden Robinson [Sat, 7 Jan 2023 09:54:31 +0000 (03:54 -0600)] 
libc.7: ffix

* Use typographer's quotation marks instead of '"' for quotation.
* Hyperlink the text "GNU C Library" to its website.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoldconfig.8: Drop discussion of libc4,5 support.
G. Branden Robinson [Sat, 7 Jan 2023 09:54:13 +0000 (03:54 -0600)] 
ldconfig.8: Drop discussion of libc4,5 support.

Drop multiple paragraphs discussing libc4 and libc5 shared library
support.  It was removed upstream in July; annotate commit.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: TH: Use lowercase
Alejandro Colomar [Sat, 7 Jan 2023 00:17:35 +0000 (01:17 +0100)] 
Many pages: TH: Use lowercase

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years ago.gitignore: Ignore checkpatch(1) output file
Alejandro Colomar [Fri, 6 Jan 2023 23:00:49 +0000 (00:00 +0100)] 
.gitignore: Ignore checkpatch(1) output file

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoldconfig.8: wfix
G. Branden Robinson [Thu, 5 Jan 2023 22:52:35 +0000 (16:52 -0600)] 
ldconfig.8: wfix

* Promote a parenthetical to primary discussion.  64-bit systems are the
  norm nowadays.
* Perform a Kemper notectomy.  That is, stop saying "note that"
  followed by some declarative statement.  This trope is all over Unix
  documentation and I even see it in ISO standards.  The latter doesn't
  serve to recommend it; as Dave Kemper has pointed out, everything we
  put in technical documentation should be worthy of note unless placed
  in a footnote, marked as "unnecessary on a first reading", or similar.
  It is the exception, not the rule.  If you feel the need to say "note
  that", consider what adjacent material you shouldn't be saying at all.
* Say "symbolic link" instead of "symlink".
* When one sentence explains the previous, use a semicolon.
* Place the modifier "only" more carefully.
* Recast option descriptions to be in the imperative mood.
* Recast file descriptions to use the paragraph tag as the subject of
  the first sentence.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoldconfig.8: ffix
G. Branden Robinson [Thu, 5 Jan 2023 22:52:25 +0000 (16:52 -0600)] 
ldconfig.8: ffix

* Set page topic in lowercase.
* Rewrite synopses to use groff man(7) `SY`/`YS` extension macros.
* Rewrite synopses to use man(7) font macros instead of *roff font
  selection escape sequences.
* In synopses, set ellipses as separate "operands" to better suggest
  argument separation by white space.
* In synopses, prevent breaks within option brackets.
* Typeset ellipses more attractively on troff devices.
* Rewrite option list to use man(7) font macros instead of *roff font
  selection escape sequences.
* Use groff man(7) `TQ` extension macro to include multiple tags for
  options with long synonyms instead of comma notation.
* Set literals used as arguments to `-c` option in bold, not italics.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agolibc.7: srcfix
G. Branden Robinson [Thu, 5 Jan 2023 22:52:55 +0000 (16:52 -0600)] 
libc.7: srcfix

* Set multi-word parentheticals on their own input lines.
* Break input lines after commas.
* Add hyphenless break points to URLs.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoldconfig.8: Sort options in synopsis
G. Branden Robinson [Thu, 5 Jan 2023 22:52:16 +0000 (16:52 -0600)] 
ldconfig.8: Sort options in synopsis

Sort options in English lexicographic order (aAbBcC...).

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoldconfig.8: srcfix
G. Branden Robinson [Thu, 5 Jan 2023 22:51:54 +0000 (16:51 -0600)] 
ldconfig.8: srcfix

* Drop stale FIXME annotation regarding commit ID for `-i` option.
* Drop redundant `PD` macro calls.
* Break input lines after commas.
* Set multi-word parentheticals on their own input lines.
* Break input lines at phrase boundaries more often.
* Protect literals from automatic hyphenation with `\%` escape sequence.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agobcmp.3, memcmp.3, strcasecmp.3, strcmp.3, strcoll.3, strxfrm.3: Deprecate bcmp(3)
Alejandro Colomar [Thu, 5 Jan 2023 21:50:25 +0000 (22:50 +0100)] 
bcmp.3, memcmp.3, strcasecmp.3, strcmp.3, strcoll.3, strxfrm.3: Deprecate bcmp(3)

It is identical to memcmp(3).  Use that.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoarc4random.3: Raise the severity of the CAVEATS to BUGS
Alejandro Colomar [Thu, 5 Jan 2023 19:14:19 +0000 (20:14 +0100)] 
arc4random.3: Raise the severity of the CAVEATS to BUGS

This is a misdesign that the original OpenBSD developers fail to
acknowledge.

Link: <https://inbox.sourceware.org/libc-alpha/068b01c4-d0c4-0849-eabb-09c020a1480b@gmail.com/T/>
Cc: "Jason A. Donenfeld" <Jason@zx2c4.com>
Cc: Arsen Arsenović <arsen@aarsen.me>
Cc: Sam James <sam@gentoo.org>
Cc: "Serge E. Hallyn" <serge@hallyn.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agomemchr.3: Deprecate rawmemchr(3)
Alejandro Colomar [Thu, 5 Jan 2023 19:01:02 +0000 (20:01 +0100)] 
memchr.3: Deprecate rawmemchr(3)

It is not optimized, and it calls either strlen(3) or memchr(3), so the
caller can do it directly, and it will be better.

Suggested-by: Wilco Dijkstra <Wilco.Dijkstra@arm.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoindex.3, memchr.3, strchr.3, string.3, strpbrk.3, strsep.3, strspn.3, strstr.3, strto...
Alejandro Colomar [Thu, 5 Jan 2023 18:38:35 +0000 (19:38 +0100)] 
index.3, memchr.3, strchr.3, string.3, strpbrk.3, strsep.3, strspn.3, strstr.3, strtok.3: Deprecate index(3) and rindex(3)

They are identical to strchr(3) and strrchr(3).  Use those.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agotimespec.3type: tfix
Thomas Weißschuh [Tue, 3 Jan 2023 23:45:34 +0000 (23:45 +0000)] 
timespec.3type: tfix

The field is correctly called "tv_nsec" as it is also used in other
places in the manpage.

Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoman-pages.7: Add preferred term "symbolic link".
G. Branden Robinson [Mon, 2 Jan 2023 18:05:34 +0000 (12:05 -0600)] 
man-pages.7: Add preferred term "symbolic link".

...per discussion with Alex Colomar.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agopath_resolution.7: wfix
G. Branden Robinson [Mon, 2 Jan 2023 18:05:24 +0000 (12:05 -0600)] 
path_resolution.7: wfix

Not counting function names and cross references to the symlink(7) page,
"symbolic link" is preferred to "symlink" in existing pages by a ratio
of about 380 to the handful in this page.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>