Various pages: Normalize SYNOPSIS notes about nonexistent glibc wrappers

To easily distinguish documentation about glibc wrappers from
documentation about kernel syscalls, let's have a normalized
'Note' in the SYNOPSIS, and a further explanation in the page body
(NOTES in most of them), as already happened in many (but not all)
of the manual pages for syscalls without a wrapper.  Furthermore,
let's normalize the messages, following membarrier.2 (because it's
already quite extended), so that it's easy to use grep to find
those pages.

To find these pages, we used:
$ grep -rn wrapper man? | sort -V
and
$ grep -rni support.*glibc | sort -V

delete_module.2, init_module.2:  glibc 2.23 is no longer
  maintained, so we changed the notes about wrappers, to say that
  there are no glibc wrappers for these system calls; see NOTES.

We didn't fix some obsolete pages such as create_module.2.

Signed-off-by: Ganimedes Colomar <gacoan.linux@gmail.com>
Cowritten-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>

diff --git a/man2/add_key.2 b/man2/add_key.2
index 1476b7d85c3af6a75d18923bd048eab57bcf8291..7c20de77754ce26694a912890a693d6e0ae656db 100644 (file)
--- a/man2/add_key.2
+++ b/man2/add_key.2
@@ -22,7 +22,8 @@ add_key \- add a key to the kernel's key management facility
 .BI "                     key_serial_t " keyring ");"
 .fi
 .PP
-No glibc wrapper is provided for this system call; see NOTES.
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 .BR add_key ()
 creates or updates a key of the given

diff --git a/man2/arch_prctl.2 b/man2/arch_prctl.2
index 97d5a2fe5b54389568c4fde9deea5921f7b948d2..e8a6da3914c3752768448dd8a9ea2472184e12df 100644 (file)
--- a/man2/arch_prctl.2
+++ b/man2/arch_prctl.2
@@ -33,6 +33,9 @@ arch_prctl \- set architecture-specific thread state
 .BI "int arch_prctl(int " code ", unsigned long " addr );
 .BI "int arch_prctl(int " code ", unsigned long *" addr );
 .fi
+.PP
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 .BR arch_prctl ()
 sets architecture-specific process or thread state.

diff --git a/man2/clone.2 b/man2/clone.2
index 0114668ea1b99a960ca1bd96f5a9eacf3ad2dee3..0d6565b5d236320bc02021fc622f6dbf7114b451 100644 (file)
--- a/man2/clone.2
+++ b/man2/clone.2
@@ -60,7 +60,7 @@ clone, __clone2, clone3 \- create a child process
 .fi
 .PP
 .IR Note :
-There is not yet a glibc wrapper for
+There is no glibc wrapper for
 .BR clone3 ();
 see NOTES.
 .SH DESCRIPTION

diff --git a/man2/delete_module.2 b/man2/delete_module.2
index daa15faa251d09daad6f70ed1c0431f1d8fab146..e63545d517f0a18cea44ce164a86f5d133dd98f5 100644 (file)
--- a/man2/delete_module.2
+++ b/man2/delete_module.2
@@ -31,7 +31,7 @@ delete_module \- unload a kernel module
 .fi
 .PP
 .IR Note :
-No declaration of this system call is provided in glibc headers; see NOTES.
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 The
 .BR delete_module ()

diff --git a/man2/init_module.2 b/man2/init_module.2
index c2675db9783a18892caf6ced28b7f0cd40bab0dd..00cf4e948d73ecf03481014a4e5b654755a15786 100644 (file)
--- a/man2/init_module.2
+++ b/man2/init_module.2
@@ -37,11 +37,7 @@ init_module, finit_module \- load a kernel module
 .fi
 .PP
 .IR Note :
-glibc provides no header file declaration of
-.BR init_module ()
-and no wrapper function for
-.BR finit_module ();
-see NOTES.
+There are no glibc wrappers for these system calls; see NOTES.
 .SH DESCRIPTION
 .BR init_module ()
 loads an ELF image into kernel space,

diff --git a/man2/keyctl.2 b/man2/keyctl.2
index 6bf07972dabd67322f4ed3582590b6040c62d5bc..f37cae8df29f664fe62954ac8facdfe65f7171df 100644 (file)
--- a/man2/keyctl.2
+++ b/man2/keyctl.2
@@ -45,7 +45,8 @@ keyctl \- manipulate the kernel's key management facility
 .BI "             __kernel_ulong_t " arg5 );
 .fi
 .PP
-No glibc wrapper is provided for this system call; see NOTES.
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 .BR keyctl ()
 allows user-space programs to perform key manipulation.

diff --git a/man2/pidfd_getfd.2 b/man2/pidfd_getfd.2
index 1a69c82389fce6236e8843ae5b8509377eadd4be..9312b6f920af594af9480f018e8b9dd7b15b99f8 100644 (file)
--- a/man2/pidfd_getfd.2
+++ b/man2/pidfd_getfd.2
@@ -29,6 +29,9 @@ pidfd_getfd \- obtain a duplicate of another process's file descriptor
 .nf
 .BI "int pidfd_getfd(int " pidfd ", int " targetfd ", unsigned int " flags );
 .fi
+.PP
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 The
 .BR pidfd_getfd ()

diff --git a/man2/pidfd_open.2 b/man2/pidfd_open.2
index 5b99460e164f0edf77c9f7194659c22563fd55c0..1b0c5e0d4a84331e6aeff4a0f89e09b7db4c42f6 100644 (file)
--- a/man2/pidfd_open.2
+++ b/man2/pidfd_open.2
@@ -31,6 +31,9 @@ pidfd_open \- obtain a file descriptor that refers to a process
 .PP
 .BI "int pidfd_open(pid_t " pid ", unsigned int " flags );
 .fi
+.PP
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 The
 .BR pidfd_open ()

diff --git a/man2/pidfd_send_signal.2 b/man2/pidfd_send_signal.2
index 6670cf3579bd403ec61d1043377ad87b6d6dc022..ffbfd17964e09787fc79d33ec6f3c0b554ebe9db 100644 (file)
--- a/man2/pidfd_send_signal.2
+++ b/man2/pidfd_send_signal.2
@@ -32,6 +32,8 @@ pidfd_send_signal \- send a signal to a process specified by a file descriptor
 .BI "int pidfd_send_signal(int " pidfd ", int " sig ", siginfo_t *" info ,
 .BI "                      unsigned int " flags );
 .fi
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 The
 .BR pidfd_send_signal ()

diff --git a/man2/request_key.2 b/man2/request_key.2
index 86f76e43db445f973699dd4c62e22c8bf5543afb..6b041d0c4d058c67a66c25997bc31bcda9b3a8be 100644 (file)
--- a/man2/request_key.2
+++ b/man2/request_key.2
@@ -22,7 +22,8 @@ request_key \- request a key from the kernel's key management facility
 .BI "                         key_serial_t " dest_keyring ");"
 .fi
 .PP
-No glibc wrapper is provided for this system call; see NOTES.
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 .BR request_key ()
 attempts to find a key of the given

diff --git a/man2/s390_guarded_storage.2 b/man2/s390_guarded_storage.2
index b3aef858f986175ece0983a31b70a157877e4db1..c3ab3bc8541e85fcaf87884ecacf62698a175aaf 100644 (file)
--- a/man2/s390_guarded_storage.2
+++ b/man2/s390_guarded_storage.2
@@ -31,6 +31,9 @@ s390_guarded_storage \- operations with z/Architecture guarded storage facility
 .PP
 .BI "int s390_guarded_storage(int " command ", struct gs_cb *" gs_cb ");"
 .fi
+.PP
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 The
 .BR s390_guarded_storage ()

diff --git a/man2/s390_pci_mmio_write.2 b/man2/s390_pci_mmio_write.2
index 802142987750524d6d1d5851bed17bebcdf15d4a..2ccd630ab2a52c7d36f08273eafa5d9835060784 100644 (file)
--- a/man2/s390_pci_mmio_write.2
+++ b/man2/s390_pci_mmio_write.2
@@ -35,6 +35,9 @@ MMIO memory page
 .BI "int s390_pci_mmio_read(unsigned long " mmio_addr ","
 .BI "                        void *" user_buffer ", size_t " length ");"
 .fi
+.PP
+.IR Note :
+There are no glibc wrappers for these system calls; see NOTES.
 .SH DESCRIPTION
 The
 .BR s390_pci_mmio_write ()

diff --git a/man2/s390_runtime_instr.2 b/man2/s390_runtime_instr.2
index 558e9c99d3ab287de785e7fdfdd6151d85f0b6f1..0f4a704de503c97cfdc7c20bfd6d7dc9e07fcc1e 100644 (file)
--- a/man2/s390_runtime_instr.2
+++ b/man2/s390_runtime_instr.2
@@ -31,6 +31,9 @@ s390_runtime_instr \- enable/disable s390 CPU run-time instrumentation
 .PP
 .BI "int s390_runtime_instr(int " command ", int " signum ");"
 .fi
+.PP
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 The
 .BR s390_runtime_instr ()

diff --git a/man2/s390_sthyi.2 b/man2/s390_sthyi.2
index 2ff06051aa5889e62c3c7713492ac636a81f5b65..70871286bbc6c95bbf00ecb6cb5acd6d656175f2 100644 (file)
--- a/man2/s390_sthyi.2
+++ b/man2/s390_sthyi.2
@@ -32,6 +32,9 @@ s390_sthyi \- emulate STHYI instruction
 .BI "int s390_sthyi(unsigned long " function_code ", void *" resp_buffer ","
 .BI "               uint64_t *" return_code ", unsigned long " flags ");"
 .fi
+.PP
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 The
 .BR s390_sthyi ()

diff --git a/man2/seccomp.2 b/man2/seccomp.2
index 6ac890a2f6a10f83602bc03bf61b9e8256fdf0e0..4600c51d6eb413ee761b6b119ad17dc02ac421ca 100644 (file)
--- a/man2/seccomp.2
+++ b/man2/seccomp.2
@@ -41,6 +41,9 @@ seccomp \- operate on Secure Computing state of the process
 .BI "int seccomp(unsigned int " operation ", unsigned int " flags \
 ", void *" args );
 .fi
+.PP
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
 .SH DESCRIPTION
 The
 .BR seccomp ()

diff --git a/man2/syslog.2 b/man2/syslog.2
index c6d6dcc94f140dac3d290aa1b6e506aa4355597c..133ba21211f71517dfa3f377e00fb085eec4ae7b 100644 (file)
--- a/man2/syslog.2
+++ b/man2/syslog.2
@@ -36,7 +36,6 @@ set console_loglevel
 .SH SYNOPSIS
 .nf
 .BI "int syslog(int " type ", char *" bufp ", int " len );
-.B  "                /* No wrapper provided in glibc */"
 .PP
 /* The glibc interface */
 .B "#include <sys/klog.h>"