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>

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>

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>

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>

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>

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>

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>

getrandom.2: Change limit to use IEC multiple symbol

Signed-off-by: Alejandro Colomar <alx@kernel.org>

reboot.2: Show BCD dates in hex not decimal

Signed-off-by: Alejandro Colomar <alx@kernel.org>

spu_run.2: Fix example comment status code or-ed value

Signed-off-by: Alejandro Colomar <alx@kernel.org>

shmget.2: Fix limit units prefix symbol from SI to IEC

Signed-off-by: Alejandro Colomar <alx@kernel.org>

perf_event_open.2: Add missing variable name

Signed-off-by: Namhyung Kim <namhyung@kernel.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

units.7: Add break points in URI

Signed-off-by: Alejandro Colomar <alx@kernel.org>

units.7: Fix escapes (\-) in URI

Signed-off-by: Alejandro Colomar <alx@kernel.org>

units.7: Use \[mc] instead of \(mc

Signed-off-by: Alejandro Colomar <alx@kernel.org>

prctl.2, man.7: Use \[ga] instead of \(ga

Signed-off-by: Alejandro Colomar <alx@kernel.org>

prctl.2: Use \[cq] instead of \(cq

Signed-off-by: Alejandro Colomar <alx@kernel.org>

prctl.2: Use \[oq] instead of \(oq

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Many pages: Use \[bu] instead of \(bu

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Various pages: Use \[rq] instead of \(rq

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Various pages: Use \[lq] instead of \(lq

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Many pages: Use \[ha] instead of \(ha

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Many pages: Use \[ti] instead of \(ti

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Many pages: Use \[em] instead of \(em

Signed-off-by: Alejandro Colomar <alx@kernel.org>

Many pages: Use \[en] instead of \(en

Signed-off-by: Alejandro Colomar <alx@kernel.org>

man-pages.7: Recommend using \[..] instead of \(.. escapes

They are more readable.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

EOF.3const: ffix

Reported-by: наб <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

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>

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>

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>

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>

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>

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>

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>

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>

landlock.7: tfix

Signed-off-by: Günther Noack <gnoack3000@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

landlock.7: ffix

Signed-off-by: Günther Noack <gnoack3000@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

bpf-helpers.7: Refresh page

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

Signed-off-by: Alejandro Colomar <alx@kernel.org>

intN_t.3type: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

cppcheck.suppress, lint-c.mk: lint-c-cppcheck: Add cppcheck(1) to the C linters

Signed-off-by: Alejandro Colomar <alx@kernel.org>

getdents.2: EXAMPLES: Fix printf() conversion specifier

Signed-off-by: Alejandro Colomar <alx@kernel.org>

fopencookie.3: EXAMPLES: Fix memory leak

Signed-off-by: Alejandro Colomar <alx@kernel.org>

seccomp_unotify.2: EXAMPLES: tfix

Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

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>

tsearch.3: EXAMPLES: Don't else after noreturn

Signed-off-by: Alejandro Colomar <alx@kernel.org>

stpncpy.3: EXAMPLES: tfix

Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

static_assert.3: srcfix

Add missing ." SRC END comment.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

Various pages: EXAMPLES: Fix -Wdeclaration-after-statement errors

Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

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>

_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>

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>

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>

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>

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>

nfsservctl.2: ffix

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Cc: mario.blaettermann@gmail.com
Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

getnameinfo.3: SYNOPSIS: Add missing _Nullable qualifiers

Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

units.7: Remove references to NIST

The SI brochure is the reference.

Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

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>

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>

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>

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>

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>

Many pages: TH: Use lowercase

Signed-off-by: Alejandro Colomar <alx@kernel.org>

.gitignore: Ignore checkpatch(1) output file

Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

intro.3: tfix

Signed-off-by: Alejandro Colomar <alx@kernel.org>

arc4random.3: Be consistent in uses of pseudorandom

Signed-off-by: Alejandro Colomar <alx@kernel.org>

arc4random_buf.3, arc4random_uniform.3: Add links to arc4random(3)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

powerof2.3: New page documenting powerof2(3)

Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

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>

scripts: tfix

Typos found with codespell.

Signed-off-by: Samanta Navarro <ferivoz@riseup.net>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

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>

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>

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>

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>