INSTALL: tfix

Signed-off-by: Eric Biggers <ebiggers@google.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

utimensat.2: tfix

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

copy_file_range.2: wfix

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

copy_file_range.2: Fix wrong kernel version information

commit d7ba612d0 ("copy_file_range.2: Update cross-filesystem support
for 5.12") prematurely documented kernel 5.12 as the version that
changes the cross-fs copy_file_range() behavior, but that behavior
change was only merged in kernel version 5.19.

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

scanf.3: Do not mention the ERANGE error

The `scanf()` function does not intentionally set `errno` to `ERANGE`.
That is just a side effect of the code that it uses to perform
conversions.  It also does not work as reliably as indicated in the
'man' page when the target integer type is narrower than `long`.
Typically (at least in glibc) for target integer types narrower than
`long`, the number has to exceed the range of `long` (for signed
conversions) or `unsigned long` (for unsigned conversions) for `errno`
to be set to `ERANGE`.

Documenting `ERANGE` in the ERRORS section kind of implies that
`scanf()` should return `EOF` when an integer overflow is encountered,
which it doesn't (and doing so would violate the C standard).

Just remove any mention of the `ERANGE` error to avoid confusion.

Fixes: 646af540e467 ("Add an ERRORS section documenting at least some of the errors that may occur for scanf().")
Link: <https://lore.kernel.org/linux-man/5af4f708-337f-fddf-9a2d-e0e4602d3a72@mev.co.uk/T/#m900a1b1741afefab008a69e6b76919cd94aa81ef>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>
Cc: Zack Weinberg <zack@owlfolio.org>
Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

scanf.3: Deprecate unsafe conversion specifiers

Use of numeric conversion specifiers can produce Undefined Behvaior
under conditions that the program doesn't control; therefore, there's no
way to use them safely.

Cc: Ian Abbott <abbotti@mev.co.uk>
Cc: Zack Weinberg <zack@owlfolio.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

core.5: Clarify that RLIMIT_CORE is ignored when piping.

Reported-by: Luca Versari <veluca93@gmail.com>
Closes: <https://bugzilla.kernel.org/show_bug.cgi?id=216648>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

intro.3: Document subsections of man3

Cowritten-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Ingo Schwarze <schwarze@openbsd.org>
Cc: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

shm_open.3: tfix

Reported-by: 1092615079 <1092615079@qq.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

socket.7: Be explicit that accept(2) respects SO_*TIMEO

See the previous commit.

Reported-by: Luis Javier Merino <ninjalj@gmail.com>
Cc: Tycho Andersen <tycho@tycho.pizza>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

socket.7: be explicit that connect(2) respects SO_*TIMEO

Our group recently had some confusion around this. Although f327722042df
("socket.7: Explain effect of SO_SNDTIMEO for connect()") adds a mention of
connect(2), the wording around "Timeouts  only  have  effect  for  system
calls  that perform socket I/O" is slightly confusing: is connect(2) I/O?.
Let's just add connect(2) to the list of things that time out explicitly to
avoid any confusion.

Test program for grins:

 #include <stdio.h>
 #include <sys/socket.h>
 #include <netinet/ip.h>
 #include <arpa/inet.h>

int main(void)
{
struct sockaddr_in servaddr = {
                /* tycho.pizza */
                .sin_addr.s_addr = inet_addr("192.241.255.151"),
                .sin_port = htons(443),
                .sin_family = AF_INET,
        };
int fd;
struct timeval timeout = {
.tv_sec = 0,
.tv_usec = 100,
};

fd = socket(AF_INET, SOCK_STREAM, 0);
if (fd < 0) {
perror("socket");
return 1;
}

if (setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO, &timeout, sizeof(timeout)) < 0) {
perror("setsockopt");
return 1;
}

if (connect(fd, (struct sockaddr *)&servaddr, sizeof(servaddr)) < 0) {
perror("connect");
return 1;
}

printf("connect successful\n");
return 0;
}

$ ./so_sndtimeo
connect: Operation now in progress

Signed-off-by: Tycho Andersen <tycho@tycho.pizza>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

stpncpy.3, strncpy.3: wfix

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

strncat.3: Overrunning the dest buffer is not that bad

With the right function call, that is, one that always copies the same
amount of bytes, and is so simple that can be inlined, the behavior
will be consistent enough to be warned by the compiler in most cases of
overrun, and crash quite consistently in the remaining.

Prefer simplicity over correctness, so suggest the simpler ustr2stp().

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

string.3, strncat.3: Undeprecate strncat(3)

After some investigation, I found a case where this function is useful:
Concatenating an unterminated string into a string.  It's not an ideal
API for that, but there's no other API that does it.

The closest thing, and something that some projects use instead of
strncat(3), is calling mempcpy(3) directly.  However mempcpy(3) isn't
ideal either (it's faster; just that).  It even requires a multiline
pattern to use correctly, which is a source of bugs.

So, suggest using a custom alternative that needs to be defined by the
programmer, which handles all the subtle details much better than any
of the conventional functions: ustr2stpe().

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

string.3, strncat.3: Fix typo in prototype of strncat(3)

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

string.3: strncpy(3), strncat(3): Obsolete, and fix

The prototype for strncat(3) was wrong.  Fix it.
Mark the functions as obsolete.
Fix the descriptions, to remove misleading text.

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

strncat.3: tfix

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

strncat.3: BUGS: Truncation

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

strcat.3, strncat.3: RIP strncat(3)

Never use this function.  Really.

Cc: <pkg-shadow-devel@alioth-lists.debian.net>
Cc: <libc-alpha@sourceware.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

strcat.3: SYNOPSIS: Fix the size of 'dest'

I had a mistake when adding VLA syntax to this prototype.  From this
fixed prototype, it's visible how broken the design for this function
is.  Next move is to kill this function.

Cc: <libc-alpha@sourceware.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

stpncpy.3: Clarify what this function is for

Use concise wording to make the points more direct.
This function is rarely used for its only valid purpose.

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

filesystems.5: Don't refer to dead software; use a more generic term

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Reported-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

strncpy.3: Rename CAVEATS to BUGS

Those are not caveats, but actual bugs.  This function was misdesigned.

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

strncpy.3: wfix

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

strncpy.3: NAME: Clarify what this function is

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

strncpy.3: SEE ALSO: Remove some references

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

strncpy.3: Deprecate strncpy(3) in favor of stpncpy(3)

It is equivalent, but reports truncation.

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

strncpy.3: Move description of valid use up

To make it more visible; and refer CAVEATS to still discourage its use.

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

strncpy.3: CAVEATS: It can't detect truncation

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

strncpy.3: ffix

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

strncpy.3: Fix TH, and add myself to copyright

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

strcpy.3, strncpy.3: Split the page and document them separately

strncpy(3) is completely unrelated to strcpy(3).  Rewrite its
documentation to be more explicit about this.

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

path_resolution.7: ffix

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

credentials.7: tfix

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

credentials.7: tfix

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

console_codes.4: tfix

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

cpow.3: tfix

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

connect.2: ffix

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

connect.2: tfix

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

wcsspn.3: NAME: Fix summary-description

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

wavelan.4: tfix

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

uts_namespaces.7: wfix

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

user_namespaces.7: Add missing word

Cc: Helge Kreutzmann <debian@helgefjell.de>
Cc: Mario Blättermann <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 Blättermann <mario.blaettermann@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

user_namespaces.7: wfix

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

towctrans.3: wfix

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

ttytype.5: tfix

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

time_namespaces.7: tfix

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

symlink.2: tfix

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

proc.5: tfix

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

Many pages: wfix

Refer consistently to software versions.  In most cases, it is done as
<software> <version>.  In the case of Linux and glibc, use the project
name, instead of other terms such as 'kernel' or 'library'.

I found the uses of inconsistent language with the following:

$ find man* -type f \
| xargs grep -i '\(since\|before\|after\|until\|to\|from\|in\|between\|version\|with\) \(kernel\|version\|2\.\|3\.\|4\.\|5\.\)' \
| sort

However, I might have missed some cases.  Anyway, 99% consistency is
pretty good consistency.  We'll fix the remaining cases as we see them.

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

passwd.5: ffix

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

network_namespaces.7: wfix

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

mount_namespaces.7: tfix

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

mq_close.3: tfix

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

malloc.3: ffix

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

mount_namespaces.7: ffix

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

mount_namespaces.7: tfix

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

keyrings.7: wfix

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

iswctype.3: wfix

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

filesystems.5: wfix

ext2 is not a high performance fs by today's standards.  And it's not
used in Linux by default.

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

errno.3: wfix

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

dsp56k.4: ffix

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

wait4.2: SYNOPSIS: Add _Nullable

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

wait.2: SYNOPSIS: Add _Nullable

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

utimensat.2: SYNOPSIS: Add _Nullable

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

utime.2: SYNOPSIS: Add _Nullable

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

timerfd_create.2: SYNOPSIS: Add _Nullable

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

timer_settime.2: SYNOPSIS: Add _Nullable

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

timer_create.2: SYNOPSIS: Add _Nullable

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

time.2: SYNOPSIS: Add _Nullable

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

splice.2: SYNOPSIS: Add _Nullable

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

sigwaitinfo.2: SYNOPSIS: Add _Nullable

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

sigprocmask.2: SYNOPSIS: Add _Nullable

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

sigaltstack.2: SYNOPSIS: Add _Nullable

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

sigaction.2: SYNOPSIS: Add _Nullable

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

shmop.2: SYNOPSIS: Add _Nullable

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

sendfile.2: SYNOPSIS: Add _Nullable

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

semop.2: SYNOPSIS: Add _Nullable

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

select.2: SYNOPSIS: Add _Nullable

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

request_key.2: SYNOPSIS: Add _Nullable

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

recv.2: SYNOPSIS: Add _Nullable

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

quotactl.2: SYNOPSIS: Add _Nullable

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

poll.2: SYNOPSIS: Add _Nullable

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

pidfd_send_signal.2: SYNOPSIS: Add _Nullable

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

nanosleep.2: SYNOPSIS: Add _Nullable

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

mount.2: SYNOPSIS: Add _Nullable

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

listxattr.2: SYNOPSIS: Add _Nullable

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

gettimeofday.2: SYNOPSIS: Add _Nullable

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

getrlimit.2: SYNOPSIS: Add _Nullable

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

getitimer.2: SYNOPSIS: Add _Nullable

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

getgroups.2: SYNOPSIS: Add _Nullable

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

getcpu.2: SYNOPSIS: Add _Nullable

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

fanotify_mark.2: SYNOPSIS: Add _Nullable

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

execveat.2: SYNOPSIS: Add _Nullable

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

execve.2: SYNOPSIS: Add _Nullable

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

epoll_wait.2: SYNOPSIS: Add _Nullable

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

epoll_ctl.2: SYNOPSIS: Add _Nullable

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

copy_file_range.2: SYNOPSIS: Add _Nullable

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

clone.2: SYNOPSIS: Add _Nullable

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