]> git.ipfire.org Git - thirdparty/man-pages.git/log
thirdparty/man-pages.git
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>
2 years agoexecveat.2: SYNOPSIS: Use the glibc prototype
Alejandro Colomar [Mon, 2 Jan 2023 16:11:11 +0000 (17:11 +0100)] 
execveat.2: SYNOPSIS: Use the glibc prototype

Glibc provides a wrapper with slightly different types (regarding
const).  Show the wrapper, which is what users will interface with.

Reported-by: Mark Galeck <markgaleck@gmail.com>
Cc: Florian Weimer <fweimer@redhat.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agointro.3: tfix
G. Branden Robinson [Mon, 2 Jan 2023 14:23:33 +0000 (08:23 -0600)] 
intro.3: tfix

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoarc4random.3: Be consistent in uses of pseudorandom
Alejandro Colomar [Mon, 2 Jan 2023 11:08:31 +0000 (12:08 +0100)] 
arc4random.3: Be consistent in uses of pseudorandom

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoarc4random_buf.3, arc4random_uniform.3: Add links to arc4random(3)
Alejandro Colomar [Sun, 1 Jan 2023 16:43:17 +0000 (17:43 +0100)] 
arc4random_buf.3, arc4random_uniform.3: Add links to arc4random(3)

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoarc4random.3: New page documenting the arc4random(3) family of functions
Alejandro Colomar [Sun, 1 Jan 2023 16:18:22 +0000 (17:18 +0100)] 
arc4random.3: New page documenting the arc4random(3) family of functions

arc4random(3)
arc4random_uniform(3)
arc4random_buf(3)

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agopowerof2.3: New page documenting powerof2(3)
Alejandro Colomar [Sat, 31 Dec 2022 01:58:34 +0000 (02:58 +0100)] 
powerof2.3: New page documenting powerof2(3)

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agobstring.3: bcopy(3)'s replacement is memmove(3), not memcpy(3)
Alejandro Colomar [Fri, 30 Dec 2022 23:04:06 +0000 (00:04 +0100)] 
bstring.3: bcopy(3)'s replacement is memmove(3), not memcpy(3)

Reported-by: Aaron Peter Bachmann <aaron_ng@inode.at>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agobstring.3: bzero(3) is not deprecated in my book
Alejandro Colomar [Fri, 30 Dec 2022 23:02:24 +0000 (00:02 +0100)] 
bstring.3: bzero(3) is not deprecated in my book

It is technically superior to memset(3) in every way.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoscripts: tfix
Samanta Navarro [Fri, 30 Dec 2022 12:03:54 +0000 (12:03 +0000)] 
scripts: tfix

Typos found with codespell.

Signed-off-by: Samanta Navarro <ferivoz@riseup.net>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agobpf-helpers.7, open_how.2type, string_copying.7: tfix
Samanta Navarro [Fri, 30 Dec 2022 12:03:02 +0000 (12:03 +0000)] 
bpf-helpers.7, open_how.2type, string_copying.7: tfix

Typos found with codespell.

Signed-off-by: Samanta Navarro <ferivoz@riseup.net>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agorand.3: SYNOPSIS: Mark rand_r() as deprecated
Alejandro Colomar [Fri, 30 Dec 2022 11:26:03 +0000 (12:26 +0100)] 
rand.3: SYNOPSIS: Mark rand_r() as deprecated

POSIX.1-2008 says so, and it's not a very useful function either.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agomemchr.3: The function always returns a pointer to the match
Alejandro Colomar [Thu, 29 Dec 2022 19:21:52 +0000 (20:21 +0100)] 
memchr.3: The function always returns a pointer to the match

Otherwise, it means we're deep into UB lands, and there be dragons.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agorand.3: EXAMPLES: Show how to get a random seed
Alejandro Colomar [Thu, 29 Dec 2022 17:13:23 +0000 (18:13 +0100)] 
rand.3: EXAMPLES: Show how to get a random seed

This is useful when testing many different cases, but repeatability is
more important than quality of the random numbers.

Cc: Jonny Grant <jg@jguk.org>
Cc: Cristian Rodríguez <crrodriguez@opensuse.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Remove references to C89
Alejandro Colomar [Thu, 29 Dec 2022 17:03:24 +0000 (18:03 +0100)] 
Many pages: Remove references to C89

C89 is obsolete, and programs should target newer standards. If someone
needs information about is, the Standard itself is a better resource.
Let's move forward, so readers get the intended notice that C89 is not a
useful version of C.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoscanf.3, sscanf.3, vsscanf.3: Split the page, one for strings and one for FILEs
Alejandro Colomar [Thu, 29 Dec 2022 11:21:28 +0000 (12:21 +0100)] 
scanf.3, sscanf.3, vsscanf.3: Split the page, one for strings and one for FILEs

From these functions, the ones that read from a FILE* are very difficult
--if not impossible-- to use correctly.  Let's split the page into two,
so that we give the impression that sscanf(3) is the first class
citizen, and the others are just historic artifacts that are kept for
backwards-compatibility reasons.

FILE* variants are now in a page which clearly tells the reader to look
for other ways to read input.

Link: <https://lore.kernel.org/linux-man/633629bd-753c-3097-9896-2491a0b0f1a2@gmail.com/T/>
Cc: Ian Abbott <abbotti@mev.co.uk>
Cc: Zack Weinberg <zack@owlfolio.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoREADME: The git repo now covers the full history
Alejandro Colomar [Thu, 29 Dec 2022 10:36:00 +0000 (11:36 +0100)] 
README: The git repo now covers the full history

See the 'prehistory' branch in the git repo for pre-1.70 versions.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agocharsets.7: tfix
Lennart Jablonka [Tue, 27 Dec 2022 19:43:41 +0000 (19:43 +0000)] 
charsets.7: tfix

Signed-off-by: Lennart Jablonka <humm@ljabl.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostring_copying.7: Remove stpecpyx()
Alejandro Colomar [Sat, 24 Dec 2022 01:29:27 +0000 (02:29 +0100)] 
string_copying.7: Remove stpecpyx()

And give stpecpy() with the semantics of stpecpyx().

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoscripts/LinuxManBook/: Add Deri's script for producing the man-pages book
Alejandro Colomar [Fri, 23 Dec 2022 23:04:57 +0000 (00:04 +0100)] 
scripts/LinuxManBook/: Add Deri's script for producing the man-pages book

Deri is the author of all of this great work!

I expect to be able to hook it into the build system, so that we can run
`make book-pdf` (or something like that).

Cc: Deri James <deri@chuzzlewit.myzen.co.uk>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostring_copying.7: tfix
Alejandro Colomar [Thu, 22 Dec 2022 22:14:51 +0000 (23:14 +0100)] 
string_copying.7: tfix

Reported-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoRELEASE: Fix command
Alejandro Colomar [Thu, 22 Dec 2022 19:44:45 +0000 (20:44 +0100)] 
RELEASE: Fix command

git-push(1) needs a remote for pushing a tag.  Specify korg, my name for
the git.kernel.org remote.

$ git remote -v | grep korg
korg git@gitolite.kernel.org:pub/scm/docs/man-pages/man-pages (fetch)
korg git@gitolite.kernel.org:pub/scm/docs/man-pages/man-pages (push)

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoStart of man-pages-NEXT: Move Changes to Changes.old
Alejandro Colomar [Thu, 22 Dec 2022 19:41:00 +0000 (20:41 +0100)] 
Start of man-pages-NEXT: Move Changes to Changes.old

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agolsm: Released 6.02
Alejandro Colomar [Thu, 22 Dec 2022 19:29:01 +0000 (20:29 +0100)] 
lsm: Released 6.02

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoChanges: Ready for 6.02 man-pages-6.02
Alejandro Colomar [Thu, 22 Dec 2022 18:58:13 +0000 (19:58 +0100)] 
Changes: Ready for 6.02

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostrncat.3: EXAMPLES: Check the return of malloc(3)
Alejandro Colomar [Wed, 21 Dec 2022 21:38:54 +0000 (22:38 +0100)] 
strncat.3: EXAMPLES: Check the return of malloc(3)

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostrcpy.3: EXAMPLES: Check the return of malloc(3)
Alejandro Colomar [Wed, 21 Dec 2022 21:35:37 +0000 (22:35 +0100)] 
strcpy.3: EXAMPLES: Check the return of malloc(3)

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostring_copying.7: tfix
Alejandro Colomar [Tue, 20 Dec 2022 15:02:07 +0000 (16:02 +0100)] 
string_copying.7: tfix

Reported-by: Stefan Puiu <stefan.puiu@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agosuffixes.7: Improve table format
G. Branden Robinson [Tue, 20 Dec 2022 03:18:16 +0000 (21:18 -0600)] 
suffixes.7: Improve table format

Apparently the original author(s) of this table did not know how to
start a table entry in the first column of a tbl(1) table with a dot.
(If you try, the *roff formatter will interpret it as a control line,
and try to invoke a request or call a macro.)

Start every row of the table with the *roff dummy character `\&` instead
of leading space.  Not only is this more idiomatic, but it recovers some
of the line length for content.

This patch does not attempt to correct any errors in the table contents,
nor bring it up to date from its year 2000 vintage.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agosuffixes.7: Drop diagnostic-suppressing hack
G. Branden Robinson [Tue, 20 Dec 2022 03:18:01 +0000 (21:18 -0600)] 
suffixes.7: Drop diagnostic-suppressing hack

The extension of the page length is workaround for
<https://savannah.gnu.org/bugs/?63449>, which is a very old groff bug,
possibily dating back to groff 1.00 or beyond.  It is fixed in groff
Git.  But waiting for a groff release is not necessary; man-db man(1)
nowadays conceals diagnostic messages from the formatter and output
drivers.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostrncat.3: Rewrite to be consistent with string_copying.7
Alejandro Colomar [Wed, 14 Dec 2022 23:14:43 +0000 (00:14 +0100)] 
strncat.3: Rewrite to be consistent with string_copying.7

Cc: Martin Sebor <msebor@redhat.com>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Cc: Jakub Wilk <jwilk@jwilk.net>
Cc: Serge Hallyn <serge@hallyn.com>
Cc: Iker Pedrosa <ipedrosa@redhat.com>
Cc: Andrew Pinski <pinskia@gmail.com>
Cc: Stefan Puiu <stefan.puiu@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostpncpy.3, strncpy.3: Document in a single page
Alejandro Colomar [Wed, 14 Dec 2022 20:06:26 +0000 (21:06 +0100)] 
stpncpy.3, strncpy.3: Document in a single page

Rewrite to be consistent with the new string_copying.7 page.

Cc: Martin Sebor <msebor@redhat.com>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Cc: Jakub Wilk <jwilk@jwilk.net>
Cc: Serge Hallyn <serge@hallyn.com>
Cc: Iker Pedrosa <ipedrosa@redhat.com>
Cc: Andrew Pinski <pinskia@gmail.com>
Cc: Stefan Puiu <stefan.puiu@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostpcpy.3, strcpy.3, strcat.3: Document in a single page
Alejandro Colomar [Wed, 14 Dec 2022 19:11:11 +0000 (20:11 +0100)] 
stpcpy.3, strcpy.3, strcat.3: Document in a single page

Rewrite to be consistent with the new string_copying.7 page.

Cc: Martin Sebor <msebor@redhat.com>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Cc: Jakub Wilk <jwilk@jwilk.net>
Cc: Serge Hallyn <serge@hallyn.com>
Cc: Iker Pedrosa <ipedrosa@redhat.com>
Cc: Andrew Pinski <pinskia@gmail.com>
Cc: Stefan Puiu <stefan.puiu@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostpecpy.3, stpecpyx.3, ustpcpy.3, ustr2stp.3, zustr2stp.3, zustr2ustp.3: Add new...
Alejandro Colomar [Mon, 12 Dec 2022 14:17:28 +0000 (15:17 +0100)] 
stpecpy.3, stpecpyx.3, ustpcpy.3, ustr2stp.3, zustr2stp.3, zustr2ustp.3: Add new links to string_copying(7)

Cc: Martin Sebor <msebor@redhat.com>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Cc: Jakub Wilk <jwilk@jwilk.net>
Cc: Serge Hallyn <serge@hallyn.com>
Cc: Iker Pedrosa <ipedrosa@redhat.com>
Cc: Andrew Pinski <pinskia@gmail.com>
Cc: Stefan Puiu <stefan.puiu@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agostring_copying.7: Add page to document all string-copying functions
Alejandro Colomar [Mon, 12 Dec 2022 00:20:55 +0000 (01:20 +0100)] 
string_copying.7: Add page to document all string-copying functions

This is an opportunity to use consistent language across the
documentation for all string-copying functions.

It is also easier to show the similarities and differences between all
of the functions, so that a reader can use this page to know which
function is needed for a given task.

Alternative functions not provided by libc have been given in the same
page, with reference implementations.

Cc: Martin Sebor <msebor@redhat.com>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Cc: Jakub Wilk <jwilk@jwilk.net>
Cc: Serge Hallyn <serge@hallyn.com>
Cc: Iker Pedrosa <ipedrosa@redhat.com>
Cc: Andrew Pinski <pinskia@gmail.com>
Cc: Stefan Puiu <stefan.puiu@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agolint-man.mk: Fix bogus stderr redirection
Alejandro Colomar [Sat, 17 Dec 2022 13:27:52 +0000 (14:27 +0100)] 
lint-man.mk: Fix bogus stderr redirection

Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoutmp.5: STANDARDS: Specify that it's an XSI extension
Alejandro Colomar [Fri, 16 Dec 2022 18:39:45 +0000 (19:39 +0100)] 
utmp.5: STANDARDS: Specify that it's an XSI extension

Cc: Serge Hallyn <serge@hallyn.com>
Cc: Iker Pedrosa <ipedrosa@redhat.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoMany pages: Add '\" t' comment where necessary
Alejandro Colomar [Wed, 9 Nov 2022 15:36:36 +0000 (16:36 +0100)] 
Many pages: Add '\" t' comment where necessary

Scripted change:

$ grep -l -x '^[.]TS$' man*/* | sort -u | xargs sed -i -e "1i'\\\\\" t"

Link: <https://lore.kernel.org/linux-man/07a7d4e7-79a6-b2c3-6892-1e39a0679f27@gmail.com/T/#mcf36c8a387fd5ff4f800dc220e3dbdd229b556bd>
Reported-by: Jakub Wilk <jwilk@jwilk.net>
Cc: Mike Frysinger <vapier@gentoo.org>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>
Cc: Stefan Puiu <stefan.puiu@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2 years agoINSTALL, Makefile, cmd.mk, lint-man.mk: Lint about '\" t' comment for tbl(1)
Alejandro Colomar [Wed, 9 Nov 2022 15:01:05 +0000 (16:01 +0100)] 
INSTALL, Makefile, cmd.mk, lint-man.mk: Lint about '\" t' comment for tbl(1)

This is to make sure that we have correct \" t comments in the pages,
which are necessary for the Debian package checker:

On 8/19/22 22:21, Jakub Wilk wrote:
> * Michael Kerrisk <mtk.manpages@gmail.com>, 2020-07-24 12:13:
>> For 15 years or at least, I've not paid any attention to adding the
>> 't' comments when I added tables to pages, and I do recall anyone
>> reporting ill effects.  So, I'm inclined to apply Mike's patch, but
>> will hold off a moment, in case there's other feedback.
>
> I'm a bit late, but...
>
> Lintian, the Debian package checker, sets the MANROFFSEQ environment
> variable to empty string as a speed optimization.  This turns off
> loading preprocessors that weren't explicitly declared in the source.
> The lack of '\" comments can cause false positives (and maybe also
> false negatives?) in Lintian.
>
> The use of $MANROFFSEQ for Lintian was proposed here:
> https://bugs.debian.org/677874
>
> Beware that the man(1) man page does not correctly explain what
> $MANROFFSEQ does: <https://bugs.debian.org/971009>

Also update the dependencies list, since now we also need head(1) and
tail(1) for linting man(7) source.

Link: <https://lore.kernel.org/linux-man/07a7d4e7-79a6-b2c3-6892-1e39a0679f27@gmail.com/T/#mcf36c8a387fd5ff4f800dc220e3dbdd229b556bd>
Reported-by: Jakub Wilk <jwilk@jwilk.net>
Cc: Mike Frysinger <vapier@gentoo.org>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>
Cc: Stefan Puiu <stefan.puiu@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>