]> git.ipfire.org Git - thirdparty/man-pages.git/log
thirdparty/man-pages.git
2 years agogsignal.3: SYNOPSIS: Mark [gs]signal() as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 11:21:23 +0000 (13:21 +0200)] 
gsignal.3: SYNOPSIS: Mark [gs]signal() as [[deprecated]]

They are obsolete in other systems, and broken in glibc.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agore_comp.3: SYNOPSIS: Mark these functions as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 10:44:40 +0000 (12:44 +0200)] 
re_comp.3: SYNOPSIS: Mark these functions as [[deprecated]]

They are MT unsafe, and replaced by the MT-safe POSIX regex(3)
functions.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agorexec.3: SYNOPSIS: Mark rexec*() as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 10:42:47 +0000 (12:42 +0200)] 
rexec.3: SYNOPSIS: Mark rexec*() as [[deprecated]]

They are insecure, and replaced by rcmd(3).

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agotoascii.3: SYNOPSIS: Mark toascii() as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 10:20:28 +0000 (12:20 +0200)] 
toascii.3: SYNOPSIS: Mark toascii() as [[deprecated]]

It cannot be used portably in a localized application.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoscalb.3: SYNOPSIS: Mark these functions as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 10:17:56 +0000 (12:17 +0200)] 
scalb.3: SYNOPSIS: Mark these functions as [[deprecated]]

Use scalbn(3) instead.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agogetcwd.3: SYNOPSIS: Use VLA notation for getwd()'s argument
Alejandro Colomar [Thu, 28 Oct 2021 23:54:25 +0000 (01:54 +0200)] 
getcwd.3: SYNOPSIS: Use VLA notation for getwd()'s argument

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agogethostbyname.3: Move non-deprecated functions to the top
Alejandro Colomar [Mon, 5 Sep 2022 01:24:11 +0000 (03:24 +0200)] 
gethostbyname.3: Move non-deprecated functions to the top

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agogethostbyname.3: SYNOPSIS: Mark several symbols as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 00:22:40 +0000 (02:22 +0200)] 
gethostbyname.3: SYNOPSIS: Mark several symbols as [[deprecated]]

*hostent*() are the only ones that are not deprecated, AFAICS.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agobcmp.3: SYNOPSIS: Mark bcmp() as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 00:10:12 +0000 (02:10 +0200)] 
bcmp.3: SYNOPSIS: Mark bcmp() as [[deprecated]]

Use memcmp(3) instead.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agogets.3: SYNOPSIS: Mark gets() as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 00:05:18 +0000 (02:05 +0200)] 
gets.3: SYNOPSIS: Mark gets() as [[deprecated]]

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoresolver.3: SYNOPSIS: Use [[deprecated]] instead of a 'Deprecated' subsection
Alejandro Colomar [Fri, 29 Oct 2021 00:03:42 +0000 (02:03 +0200)] 
resolver.3: SYNOPSIS: Use [[deprecated]] instead of a 'Deprecated' subsection

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoperror.3: SYNOPSIS: Mark sys_errlist[] and sys_nerr as [[deprecated]]
Alejandro Colomar [Thu, 28 Oct 2021 23:57:26 +0000 (01:57 +0200)] 
perror.3: SYNOPSIS: Mark sys_errlist[] and sys_nerr as [[deprecated]]

They are no longer exposed by glibc.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agogetcwd.3: SYNOPSIS: Mark getwd() as [[deprecated]]
Alejandro Colomar [Thu, 28 Oct 2021 23:52:14 +0000 (01:52 +0200)] 
getcwd.3: SYNOPSIS: Mark getwd() as [[deprecated]]

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agostrsignal.3: SYNOPSIS: Mark sys_siglist[] as [[deprecated]]
Alejandro Colomar [Thu, 28 Oct 2021 23:49:28 +0000 (01:49 +0200)] 
strsignal.3: SYNOPSIS: Mark sys_siglist[] as [[deprecated]]

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoinet.3: SYNOPSIS: Mark inet_ntoa() as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:31:07 +0000 (21:31 +0200)] 
inet.3: SYNOPSIS: Mark inet_ntoa() as [[deprecated]]

See inet_ntop(3).

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agostrcpy.3: SYNOPSIS: Add missing 'restrict'
Alejandro Colomar [Mon, 28 Jun 2021 20:37:31 +0000 (22:37 +0200)] 
strcpy.3: SYNOPSIS: Add missing 'restrict'

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agopthread_mutexattr_setrobust.3: SYNOPSIS: Mark *_np() old functions as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:33:03 +0000 (21:33 +0200)] 
pthread_mutexattr_setrobust.3: SYNOPSIS: Mark *_np() old functions as [[deprecated]]

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoreaddir_r.3: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:32:02 +0000 (21:32 +0200)] 
readdir_r.3: SYNOPSIS: Mark as [[deprecated]]

Glibc:

dirent/dirent.h:183:
extern int readdir_r (DIR *__restrict __dirp,
                      struct dirent *__restrict __entry,
                      struct dirent **__restrict __result)
     __nonnull ((1, 2, 3)) __attribute_deprecated__;

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agopthread_yield.3: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:31:30 +0000 (21:31 +0200)] 
pthread_yield.3: SYNOPSIS: Mark as [[deprecated]]

sched_yield(3) is identical and is in POSIX.
See glibc commit c2fd60a5861efef48252f5cc7efc70e1d8a0da9a.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agogetipnodebyname.3: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:29:55 +0000 (21:29 +0200)] 
getipnodebyname.3: SYNOPSIS: Mark as [[deprecated]]

These functions are not anymore in glibc.  All other systems
call them deprecated.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agogamma.3: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:29:29 +0000 (21:29 +0200)] 
gamma.3: SYNOPSIS: Mark as [[deprecated]]

These functions are misleading, and in some systems mean a
different thing (tgamma(3) vs lgamma(3)).  Never use gamma(3).

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agobcopy.3: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:28:28 +0000 (21:28 +0200)] 
bcopy.3: SYNOPSIS: Mark as [[deprecated]]

memmove(3) completely replaces bcopy(3), being an almost identical
function, except for the different order in the arguments.

memmove(3) is part of ISO C and POSIX.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agouselib.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 01:02:10 +0000 (03:02 +0200)] 
uselib.2: SYNOPSIS: Mark as [[deprecated]]

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agosysfs.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 00:57:14 +0000 (02:57 +0200)] 
sysfs.2: SYNOPSIS: Mark as [[deprecated]]

Use proc(5) instead.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agosetpgid.2: SYNOPSIS: Mark BSD versions of getpgrp() and setpgrp() as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 00:55:17 +0000 (02:55 +0200)] 
setpgid.2: SYNOPSIS: Mark BSD versions of getpgrp() and setpgrp() as [[deprecated]]

The BSD version of getpgrp(2) was superseeded by the POSIX one.
The BSD version of setpgrp(2) was superseeded by the POSIX one.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agofutimesat.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 00:37:25 +0000 (02:37 +0200)] 
futimesat.2: SYNOPSIS: Mark as [[deprecated]]

Use utimensat(2) instead.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agosgetmask.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 00:33:27 +0000 (02:33 +0200)] 
sgetmask.2: SYNOPSIS: Mark as [[deprecated]]

Use sigprocmask(2) instead.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agotkill.2: SYNOPSIS: Mark tkill() as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 00:31:25 +0000 (02:31 +0200)] 
tkill.2: SYNOPSIS: Mark tkill() as [[deprecated]]

tkill(2) has been superseeded by tgkill(2).

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agosysctl.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Fri, 29 Oct 2021 00:11:35 +0000 (02:11 +0200)] 
sysctl.2: SYNOPSIS: Mark as [[deprecated]]

This syscall no longer exists!

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agopthread_mutex_consistent.3: Mark *_np() old function as [[deprecated]]
Alejandro Colomar [Thu, 28 Oct 2021 23:41:31 +0000 (01:41 +0200)] 
pthread_mutex_consistent.3: Mark *_np() old function as [[deprecated]]

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoustat.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:37:45 +0000 (21:37 +0200)] 
ustat.2: SYNOPSIS: Mark as [[deprecated]]

Glibc 2.28 removed the wrapper for this syscall.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agostime.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:37:35 +0000 (21:37 +0200)] 
stime.2: SYNOPSIS: Mark as [[deprecated]]

This syscall was removed from glibc 2.31 for newly linked
programs.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agostatfs.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:37:21 +0000 (21:37 +0200)] 
statfs.2: SYNOPSIS: Mark as [[deprecated]]

LSB deprecated these syscalls in favor of [f]statvfs(3).

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agosigprocmask.2: SYNOPSIS: Mark the legacy system call as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:36:49 +0000 (21:36 +0200)] 
sigprocmask.2: SYNOPSIS: Mark the legacy system call as [[deprecated]]

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoremap_file_pages.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:35:56 +0000 (21:35 +0200)] 
remap_file_pages.2: SYNOPSIS: Mark as [[deprecated]]

This syscall was marked as deprecated in Linux 3.16.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoquery_module.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:35:32 +0000 (21:35 +0200)] 
query_module.2: SYNOPSIS: Mark as [[deprecated]]

This syscall was removed in Linux 2.6.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoiopl.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:35:21 +0000 (21:35 +0200)] 
iopl.2: SYNOPSIS: Mark as [[deprecated]]

ioperm(2) is recommended instead.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agogetunwind.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:35:09 +0000 (21:35 +0200)] 
getunwind.2: SYNOPSIS: Mark as [[deprecated]]

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoget_kernel_syms.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:34:53 +0000 (21:34 +0200)] 
get_kernel_syms.2: SYNOPSIS: Mark as [[deprecated]]

This syscall was removed in Linux 2.6.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agocreate_module.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:34:38 +0000 (21:34 +0200)] 
create_module.2: SYNOPSIS: Mark as [[deprecated]]

This syscall was removed in Linux 2.6.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agobdflush.2: SYNOPSIS: Mark as [[deprecated]]
Alejandro Colomar [Mon, 25 Oct 2021 19:34:21 +0000 (21:34 +0200)] 
bdflush.2: SYNOPSIS: Mark as [[deprecated]]

This syscal is not supported anymore by glibc, and does nothing.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoNULL.3const: Add documentation for NULL
Alejandro Colomar [Fri, 22 Jul 2022 15:29:48 +0000 (17:29 +0200)] 
NULL.3const: Add documentation for NULL

Reported-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Ralph Corderoy <ralph@inputplus.co.uk>
Cc: Ingo Schwarze <schwarze@usta.de>
Cc: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoMakefile, install-man.mk: Adapt makefiles to new 3const subsection
Alejandro Colomar [Fri, 22 Jul 2022 15:29:10 +0000 (17:29 +0200)] 
Makefile, install-man.mk: Adapt makefiles to new 3const subsection

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoVarious pages: SYNOPSIS: ffix
Alejandro Colomar [Sun, 4 Sep 2022 22:45:17 +0000 (00:45 +0200)] 
Various pages: SYNOPSIS: ffix

Enclose struct/union definitions in EX/EE.

nf/fi produces alignment issues in output devices where the font
is not monospaced.  EX/EE forces use of monospaced font, so it's
more appropriate to format SYNOPSIS that contain structure types,
where alignment is essential.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoioctl_console.2: document all extant TIOCLINUX subcodes as of 6.0 (2.6.17)
наб [Fri, 2 Sep 2022 13:07:16 +0000 (15:07 +0200)] 
ioctl_console.2: document all extant TIOCLINUX subcodes as of 6.0 (2.6.17)

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Cc: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoioctl_console.2: devices/char/console.c and sel_buffer don't exist anymore
наб [Fri, 2 Sep 2022 13:06:57 +0000 (15:06 +0200)] 
ioctl_console.2: devices/char/console.c and sel_buffer don't exist anymore

And haven't for over a decade.

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Cc: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoioctl_console.2: use symbolic subcodes
наб [Fri, 2 Sep 2022 13:06:15 +0000 (15:06 +0200)] 
ioctl_console.2: use symbolic subcodes

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Cc: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agohosts.5: Use "example.org" as example domain
Jakub Wilk [Wed, 31 Aug 2022 13:41:28 +0000 (15:41 +0200)] 
hosts.5: Use "example.org" as example domain

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agosysvipc.7: tfix
Štěpán Němec [Thu, 1 Sep 2022 13:01:17 +0000 (15:01 +0200)] 
sysvipc.7: tfix

Signed-off-by: Štěpán Němec <stepnem@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoioctl_console.2: ffix
наб [Thu, 1 Sep 2022 13:35:52 +0000 (15:35 +0200)] 
ioctl_console.2: ffix

Separate TIOCLINUX from subcode: they're separate variables

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoioctl_ns.2, stat.2: Drop unneeded uintmax_t casts
Jakub Wilk [Tue, 30 Aug 2022 19:58:00 +0000 (21:58 +0200)] 
ioctl_ns.2, stat.2: Drop unneeded uintmax_t casts

major() and minor() return unsigned int,
so the typecasts to uintmax_t are not needed.

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agotermios.3: mention the integer types in SEE ALSO
наб [Mon, 29 Aug 2022 21:46:50 +0000 (23:46 +0200)] 
termios.3: mention the integer types in SEE ALSO

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agocc_t.3type, speed_t.3type, tcflag_t.3type: document all together
наб [Mon, 29 Aug 2022 22:33:52 +0000 (00:33 +0200)] 
cc_t.3type, speed_t.3type, tcflag_t.3type: document all together

speed_t and tcflag_t were both unmentioned in general

Issue 7 has this to say:
  The <termios.h> header shall define the following data types through typedef:
    cc_t     Used for terminal special characters.
    speed_t  Used for terminal baud rates.
    tcflag_t Used for terminal modes.
  The above types shall be all unsigned integer types.

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolint-man.mk: Redirect groff output to stderr
Alejandro Colomar [Sun, 28 Aug 2022 11:30:42 +0000 (13:30 +0200)] 
lint-man.mk: Redirect groff output to stderr

groff(1) is being used to warn.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agocmd.mk, lint-man.mk: Use MANWIDTH instead of a hardcoded 80
Alejandro Colomar [Sun, 28 Aug 2022 11:18:54 +0000 (13:18 +0200)] 
cmd.mk, lint-man.mk: Use MANWIDTH instead of a hardcoded 80

Also need another variable set to MANWIDTH - 2, since troff needs
room for two extra characters for some reason.

Cc: Ralph Corderoy <ralph@inputplus.co.uk>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolint-man.mk: Use ascii instead of utf8
Alejandro Colomar [Sun, 28 Aug 2022 10:56:49 +0000 (12:56 +0200)] 
lint-man.mk: Use ascii instead of utf8

This is relevant for tables, which will now use ASCIIart, instead
of pretty multi-byte characters which interfere with the
calculation of the line width.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolint-man.mk: Use grep through its command variable
Alejandro Colomar [Sun, 28 Aug 2022 10:55:05 +0000 (12:55 +0200)] 
lint-man.mk: Use grep through its command variable

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolint-man.mk: Remove highlighting in a more robust way
Alejandro Colomar [Sun, 28 Aug 2022 10:53:11 +0000 (12:53 +0200)] 
lint-man.mk: Remove highlighting in a more robust way

'grotty -c | col -bx' is more reliable, and far more readable.

Suggested-by: Ralph Corderoy <ralph@inputplus.co.uk>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolint-man.mk: Specify the output device through a variable
Alejandro Colomar [Sun, 28 Aug 2022 10:34:25 +0000 (12:34 +0200)] 
lint-man.mk: Specify the output device through a variable

Suggested-by: Ralph Corderoy <ralph@inputplus.co.uk>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolint-man.mk: Use a pipeline instead of the groff(1) wrapper
Alejandro Colomar [Sat, 27 Aug 2022 18:55:41 +0000 (20:55 +0200)] 
lint-man.mk: Use a pipeline instead of the groff(1) wrapper

This more explicitly shows how stuff really works, and allows
inspecting some intermediate steps in case it may be necessary.

Cc: Ralph Corderoy <ralph@inputplus.co.uk>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: <groff@gnu.org>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolint-man.mk: Use UTF-8 output
Alejandro Colomar [Sat, 27 Aug 2022 19:07:18 +0000 (21:07 +0200)] 
lint-man.mk: Use UTF-8 output

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoman7/regex.7: change "\o'o\(ha'"to a real character "\(^o" (o circumflex)
Bjarni Ingi Gislason [Fri, 26 Aug 2022 22:11:51 +0000 (22:11 +0000)] 
man7/regex.7: change "\o'o\(ha'"to a real character "\(^o" (o circumflex)

  Use real accented characters instead of producing them by overstriking
the letter with the diacritic mark.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@vortex.is>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolint-man.mk: Force groff(1) to use 80 columns
Alejandro Colomar [Fri, 26 Aug 2022 19:23:35 +0000 (21:23 +0200)] 
lint-man.mk: Force groff(1) to use 80 columns

Cc: Ralph Corderoy <ralph@inputplus.co.uk>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agopthread_setname_np.3: Rename 'len' to 'size'
Alejandro Colomar [Thu, 25 Aug 2022 22:04:12 +0000 (00:04 +0200)] 
pthread_setname_np.3: Rename 'len' to 'size'

The parameter doesn't represent a string length (strlen(3)), but a
buffer size (sizeof()).  Use a more proper name.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoconfstr.3: Rename 'len' to 'size'
Alejandro Colomar [Thu, 25 Aug 2022 20:15:17 +0000 (22:15 +0200)] 
confstr.3: Rename 'len' to 'size'

The parameter doesn't represent a string length (strlen(3)), but a
buffer size (sizeof()).  Use a more proper name.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoVarious pages: Fit rendered pages in 80 columns
Alejandro Colomar [Thu, 25 Aug 2022 19:55:00 +0000 (21:55 +0200)] 
Various pages: Fit rendered pages in 80 columns

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agowcswidth.3, wcwidth.3, veth.4: Fix accidents in .TH
Alejandro Colomar [Thu, 25 Aug 2022 19:53:24 +0000 (21:53 +0200)] 
wcswidth.3, wcwidth.3, veth.4: Fix accidents in .TH

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolint-man.mk: Check that rendered pages don't go past 80 column
Alejandro Colomar [Thu, 25 Aug 2022 19:38:18 +0000 (21:38 +0200)] 
lint-man.mk: Check that rendered pages don't go past 80 column

Until groff(1) or mandoc(1) add such a warning, this is good
enough.

Link: <https://lists.gnu.org/archive/html/groff/2022-08/msg00197.html>
Link: <https://stackoverflow.com/a/24005600/6872717>
Cc: Ingo Schwarze <schwarze@openbsd.org>
Cc: Ralph Corderoy <ralph@inputplus.co.uk>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Dave Kemper <saint.snit@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoCONTRIBUTING: Add more information about the mailing list
Alejandro Colomar [Thu, 25 Aug 2022 11:11:45 +0000 (13:11 +0200)] 
CONTRIBUTING: Add more information about the mailing list

Put the 'Mailing list' section the first one, since it's the most
important, and rewrite it to be more informative (so we don't need
to redirect to the website for everything).  Also reorganize a
little bit around that change.

Reported-by: Jakub Wilk <jwilk@jwilk.net>
Reported-by: NeilBrown <neilb@suse.de>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoRevert "Many pages: Document fixed-width types with ISO C naming"
Alejandro Colomar [Thu, 25 Aug 2022 07:39:55 +0000 (09:39 +0200)] 
Revert "Many pages: Document fixed-width types with ISO C naming"

This reverts commit 2294974b3a1341e457edb682c08c5f4b2d14675e.

Reported-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoMany pages: Document fixed-width types with ISO C naming man-pages-6.0-rc1
Alejandro Colomar [Sun, 21 Aug 2022 22:49:53 +0000 (00:49 +0200)] 
Many pages: Document fixed-width types with ISO C naming

Kernel __u64 and similar types are ABI-compatible, and mostly
API-compatible with ISO C types.  User-space programmers don't
care about kernel details, and should only use libc types.
Document syscalls and structures provided by the Linux kernel as
if they used libc types.

There's work in the kernel to remove this small API
incompatibility, which is only for pointers or printf specifiers.

Since I couldn't find any structure that uses pointers, there
shouldn't be any issues here.  Also, the only pointer I found was
in a syscall parameter, but since syscall(2) doesn't check its
arguments' types, we're also safe there.

This patch doesn't go without controversy.  Check the discussions
in the links below.

Found with:

$ grep -rn '\b_*[su][8136][624]*\b' man* \
  | grep -v -e /bpf-helpers.7 -e /proc.5 -e /epoll_event.3type -e /wcscmp.3 \
            -e /crypt.3 -e /mempcpy.3 -e /memcmp.3 -e /string.3 -e /wcsncmp.3 \
            -e /wcscasecmp.3 -e /wmemcmp.3 -e /strcasecmp.3 -e /bcmp.3 \
            -e /bstring.3 -e /endian.3 -e /strverscmp.3 -e /wcsncasecmp.3 \
            -e /strcoll.3 -e /strcmp.3 \
  | tee /dev/tty \
  | wc -l;

Link: <https://lore.kernel.org/linux-man/20210423230609.13519-1-alx.manpages@gmail.com/T/>
Link: <https://lore.kernel.org/lkml/YZvIlz7J6vOEY+Xu@yuki/T/>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Nacked-by: Alexei Starovoitov <ast@kernel.org>
Nacked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Nacked-by: Daniel Borkmann <daniel@iogearbox.net>
Acked-by: Zack Weinberg <zackw@panix.com>
Cc: LKML <linux-kernel@vger.kernel.org>
Cc: glibc <libc-alpha@sourceware.org>
Cc: GCC <gcc-patches@gcc.gnu.org>
Cc: bpf <bpf@vger.kernel.org>
Cc: LTP List <ltp@lists.linux.it>
Cc: Linux API <linux-api@vger.kernel.org>
Cc: linux-arch <linux-arch@vger.kernel.org>
Cc: David Laight <David.Laight@ACULAB.COM>
Cc: Joseph Myers <joseph@codesourcery.com>
Cc: Florian Weimer <fweimer@redhat.com>
Cc: Daniel Borkmann <daniel@iogearbox.net>
Cc: Cyril Hrubis <chrubis@suse.cz>
Cc: David Howells <dhowells@redhat.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Florian Weimer <fweimer@redhat.com>
Cc: Rich Felker <dalias@libc.org>
Cc: Adhemerval Zanella <adhemerval.zanella@linaro.org>
2 years agoprint_encoding.sh: Remove unused script
Alejandro Colomar [Wed, 24 Aug 2022 18:32:18 +0000 (20:32 +0200)] 
print_encoding.sh: Remove unused script

It considers every page as utf-8, so it doesn't provide any useful
information.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agocheck_unbalanced_macros.sh: This script's functionality is already covered by 'make...
Alejandro Colomar [Wed, 24 Aug 2022 18:22:58 +0000 (20:22 +0200)] 
check_unbalanced_macros.sh: This script's functionality is already covered by 'make lint-man'

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years ago_Generic.3: EXAMPLES: Use a constant expression
Alejandro Colomar [Wed, 24 Aug 2022 11:47:21 +0000 (13:47 +0200)] 
_Generic.3: EXAMPLES: Use a constant expression

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoappend_COLOPHON.sh, remove_COLOPHON.sh: Remove COLOPHON section.
Alejandro Colomar [Wed, 24 Aug 2022 15:37:35 +0000 (17:37 +0200)] 
append_COLOPHON.sh, remove_COLOPHON.sh: Remove COLOPHON section.

Users should use their distribution's standard tools to know where
a given page comes from and to know how to report a bug.  That'll
create a small barrier to bug reporters, but that'll hopefully
help improve the quality of the reports.

It'll also make the pages cleaner, by removing stuff that is
obvious to those who know how to use their tools.

We still keep part of the information of the COLOPHON,
specifically the project name and the version, in the .TH line.

Reported-by: Ingo Schwarze <schwarze@openbsd.org>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoutime.2, utimensat.2: explicitly mention ctime changing.
NeilBrown [Wed, 24 Aug 2022 01:21:34 +0000 (11:21 +1000)] 
utime.2, utimensat.2: explicitly mention ctime changing.

utime and related calls always change the ctime.  It is worth making
this explicit.
This is clear from the code (vfs_utimes() in fs/utimes.c always sets
ATTR_CTIME) and is documented in
  <https://pubs.opengroup.org/onlinepubs/007904875/functions/utimes.html>

Signed-off-by: NeilBrown <neilb@suse.de>
Reviewed-by: Jeff Layton <jlayton@kernel.org>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years ago_Generic.3: intmax_t can't be int
Alejandro Colomar [Sun, 21 Aug 2022 15:12:52 +0000 (17:12 +0200)] 
_Generic.3: intmax_t can't be int

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoman-pages.7: Document recent changes to .TH
Alejandro Colomar [Sun, 21 Aug 2022 12:22:48 +0000 (14:22 +0200)] 
man-pages.7: Document recent changes to .TH

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Cc: Jakub Wilk <jwilk@jwilk.net>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Ingo Schwarze <schwarze@openbsd.de>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>
2 years agoAll pages: Remove the 5th argument to .TH
Alejandro Colomar [Sun, 21 Aug 2022 12:10:16 +0000 (14:10 +0200)] 
All pages: Remove the 5th argument to .TH

Now that we have the LIBRARY section, and a 4th argument that
already tells that it's a page from the Linux man-pages project,
the 5th argument isn't telling any information that the default
value wouldn't.  So let's just remove it.

Scripted change:

$ find man* -type f \
  | xargs sed -Ei '/^.TH /s/(.TH +[^ ]+ +[^ ]+ +[^ ]+ +"[^"]+") .*/\1/'

Acked-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Cc: Ingo Schwarze <schwarze@openbsd.de>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>
2 years agodist.mk, version.mk: dist: Add version to .TH
Alejandro Colomar [Sat, 20 Aug 2022 16:14:25 +0000 (18:14 +0200)] 
dist.mk, version.mk: dist: Add version to .TH

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Cc: Ingo Schwarze <schwarze@openbsd.de>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
2 years agoAll pages: Replace the 4th argument to .TH by "Linux man-pages (unreleased)"
Alejandro Colomar [Sat, 20 Aug 2022 11:48:02 +0000 (13:48 +0200)] 
All pages: Replace the 4th argument to .TH by "Linux man-pages (unreleased)"

On 8/20/22 13:57, Alejandro Colomar wrote:
> On 8/20/22 07:43, G. Branden Robinson wrote:
>>
>> In my opinion it would benefit readers of the Linux man-pages if the
>> fourth argument to `TH` were what it is in many other man pages: an
>> identifier for the name and version number of the release originating
>> them.  In every page it would be clear what version of the man-pages was
>> being viewed.  Little sophistication would be demanded of the user to
>> check the Web to determine the relative age of the pages, independently
>> of the modification date of the particular page.  Such usage would be
>> congruent with the argument's purpose in AT&T and BSD Unix, where this
>> datum was "7th Edition", "System III", or "4.2 Berkeley Distribution",
>> or similar.
>
> I thought about it in the past...  That field was the only thing that
> said where a function came from.  If we removed GNU (or something else),
> how would someone know where does the function or whatever comes from??
>
> I guess that's also why the colophon was appended to the pages by
> Michael.  Since we couldn't use the 4th field for that, we had to have a
> COLOPHON section.
>
> However, the addition of the LIBRARY section seems to fix this issue,
> and so now we have an even more precise way to determine where a given
> function comes from (including the library file name, and the linker
> option).
>
> This gives me another argument for those who don't like to have a
> LIBRARY section for libc stuff (since -lc is unnecessary), and consider
> it noise.
>
>>
>> Further, as the libc-related man pages in this project expand coverage
>> to other libcs than GNU's, the alternatives to the empty string
>> proferred in man-pages(7) seem less and less appropriate.
>
> Agree.  LIBRARY seems much more appropriate for that purpose.
>
> And this helps remove the COLOPHON section (or at least, we don't need
> to autogenerate it, since the version number now comes in .TH, and the
> COLOPHON is static; so I can even move it to a smaller REPORTING BUGS
> section).

Scripted change:

$ find man* -type f \
  |xargs sed -Ei '/^.TH /s/(.TH +[^ ]+ +[^ ]+ +[^ ]+) +"[^"]*"/\1 "Linux man-pages (unreleased)"/'

$ find man* -type f \
  |xargs sed -Ei '/^.TH /s/(.TH +[^ ]+ +[^ ]+ +[^ ]+) +[^" ]+/\1 "Linux man-pages (unreleased)"/'

$ git restore man5/tzfile.5
$ git restore man8/zdump.8
$ git restore man8/zic.8
$ git restore man7/bpf-helpers.7

Link: <https://lore.kernel.org/linux-man/20220819180323.dbsgxh5qvcjabjm6@jwilk.net/T/#u>
Reported-by: Jakub Wilk <jwilk@jwilk.net>
Reported-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Cc: Ingo Schwarze <schwarze@openbsd.de>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>
2 years ago_Generic.3: New page documenting _Generic()
Alejandro Colomar [Sat, 20 Aug 2022 16:57:51 +0000 (18:57 +0200)] 
_Generic.3: New page documenting _Generic()

Also add a hint of how intmax(3) and other functions using
[u]intmax_t types could be better defined by ISO C, by requiring
that they're implemented as type-generic macros, to avoid having
problems with the ABI.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Cc: JeanHeyd Meneide <wg14@soasis.org>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Ingo Schwarze <schwarze@openbsd.de>
2 years agobuild.mk: clean: Show some output
Alejandro Colomar [Sun, 21 Aug 2022 11:41:22 +0000 (13:41 +0200)] 
build.mk: clean: Show some output

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agofanotify_init.2: srcfix
Alejandro Colomar [Sun, 21 Aug 2022 11:25:52 +0000 (13:25 +0200)] 
fanotify_init.2: srcfix

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agofanotify_init.2: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:50 +0000 (21:08 +0200)] 
fanotify_init.2: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agobuild-src.mk: Fix appending -Wstrict-prototypes
Jakub Wilk [Fri, 19 Aug 2022 18:24:31 +0000 (20:24 +0200)] 
build-src.mk: Fix appending -Wstrict-prototypes

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agotcp.7: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:59 +0000 (21:08 +0200)] 
tcp.7: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agofanotify.7: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:58 +0000 (21:08 +0200)] 
fanotify.7: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agotm.3type: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:57 +0000 (21:08 +0200)] 
tm.3type: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agotimespec.3type: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:56 +0000 (21:08 +0200)] 
timespec.3type: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoitimerspec.3type: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:55 +0000 (21:08 +0200)] 
itimerspec.3type: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agodev_t.3type: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:54 +0000 (21:08 +0200)] 
dev_t.3type: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoclockid_t.3type: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:53 +0000 (21:08 +0200)] 
clockid_t.3type: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agomemfd_secret.2: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:52 +0000 (21:08 +0200)] 
memfd_secret.2: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agolandlock_restrict_self.2: tfix
Jakub Wilk [Fri, 19 Aug 2022 19:08:51 +0000 (21:08 +0200)] 
landlock_restrict_self.2: tfix

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agoclang-tidy/config.yaml: Ignore a useless warning
Alejandro Colomar [Wed, 17 Aug 2022 13:31:31 +0000 (15:31 +0200)] 
clang-tidy/config.yaml: Ignore a useless warning

-readability-identifier-length

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agospufs.7: tfix
Alejandro Colomar [Mon, 15 Aug 2022 22:03:15 +0000 (00:03 +0200)] 
spufs.7: tfix

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agospufs.7: wfix + ffix
Alejandro Colomar [Mon, 15 Aug 2022 21:54:14 +0000 (23:54 +0200)] 
spufs.7: wfix + ffix

Reported-by: Ingo Schwartze <schwarze@openbsd.org>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agogetaddrinfo_a.3: actually gnu.cz => gnu.org
наб [Mon, 15 Aug 2022 21:33:49 +0000 (23:33 +0200)] 
getaddrinfo_a.3: actually gnu.cz => gnu.org

Fixes: a2feb3e14f51a0e74daeb6f0217887ca31799967 ("getaddrinfo_a.3:
 gnu.cz => gnu.org")
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2 years agofutex.2, futex.7: {ftp://ftp => https://mirrors}.kernel.org
наб [Mon, 15 Aug 2022 21:33:44 +0000 (23:33 +0200)] 
futex.2, futex.7: {ftp://ftp => https://mirrors}.kernel.org

The former doesn't exist; the latter is the new location with seemingly
compatible data

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>