Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6F4DDC433DB for ; Wed, 30 Dec 2020 15:21:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 4000B207A6 for ; Wed, 30 Dec 2020 15:21:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726352AbgL3PVj (ORCPT ); Wed, 30 Dec 2020 10:21:39 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33122 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726276AbgL3PVi (ORCPT ); Wed, 30 Dec 2020 10:21:38 -0500 Received: from mail-wm1-x333.google.com (mail-wm1-x333.google.com [IPv6:2a00:1450:4864:20::333]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4E1D9C06179B for ; Wed, 30 Dec 2020 07:20:58 -0800 (PST) Received: by mail-wm1-x333.google.com with SMTP id v14so5194529wml.1 for ; Wed, 30 Dec 2020 07:20:58 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=7QZOQtX8TdrrQ5951y1vJPjYYD/ySiYh4Ft+M61xFb0=; b=choN3gQ+r0ZxvHZtc19XDjeaz4SMv92/0emScqH6VWhjXNQMCEDj3PExdIdza6N6iz 35h1mi/cftWRhVqMphmorkx56jLOJpwLgRJI7k2M1Qx82I43yvOfWLsWQlEyJ3D0TF8y Ha9UBBfOVv/fLg7z5rlbuVrTXOdaNacPeO6ReFWJeA8B1BD6+Tibbi3QLWBmbkJteuSu VhPqIeTuYFbJr/hZkm9LDOedZPZQci26s5vxuOvhxMtPVoLuSzUx2hPOYPygzYRXHdCe M63zwrtap/aLb8Lgo+OCE9vwVSH6SD5DB3t6lhL2NQPffcTqI5wE+ghJtCXCoJBKF8Aa 5CjQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=7QZOQtX8TdrrQ5951y1vJPjYYD/ySiYh4Ft+M61xFb0=; b=qZhiuhH9rpS7JiK0mLjGelJCcHNVPdAN5qBBT96ZNyeCqy0HSFGP+JYYOBcAy1EcIT pQIVqrTi2ANqZn6rR2AKX8DQ5j/i40fhzICwFqSZJDgW4iiS6+gIq0o5XuPaRGhPDG3R OVDk81vrxjY2BJLKdnP3l5+QKXaWBddJRy/7fZ7gUcMF1MDP9UsOuqYZLaH+N3vCVfQC SWQUQXXkYAoaMPmMvEGQovJBg0pOadMWG3//8UZ86fxf0yIyIYy1dRrrbaQ+vxDAdEZ5 Lh7AsYCV7yjTATxMRDMSm3c6Y/cfvTiHrBPaRWfV1Obh1rV7j7P4Mi9w2n1AxTGoYw/J D46g== X-Gm-Message-State: AOAM531PIf/l1Yx6e/3NezUs2BhRSf/2qDUgtpce1YwCS27dtx4QmfL+ 3pkxWOGzbkWWJaQEv+C+CKyZoG2H+pM= X-Google-Smtp-Source: ABdhPJz5eXxAQEHhhLi6HCLwHAxdx3HJYH5fRlVd4TGLxjVJvnCprUX7J0gTWchAgmu0FGdlqLYm9w== X-Received: by 2002:a1c:2646:: with SMTP id m67mr8075459wmm.81.1609341656992; Wed, 30 Dec 2020 07:20:56 -0800 (PST) Received: from localhost.localdomain ([170.253.49.0]) by smtp.googlemail.com with ESMTPSA id r13sm65599786wrs.6.2020.12.30.07.20.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 30 Dec 2020 07:20:56 -0800 (PST) From: Alejandro Colomar To: mtk.manpages@gmail.com Cc: Ganimedes Colomar , linux-man@vger.kernel.org, Alejandro Colomar Subject: [PATCH v2 1/2] Various pages: Normalize SYNOPSIS notes about nonexistent glibc wrappers Date: Wed, 30 Dec 2020 16:20:25 +0100 Message-Id: <20201230152025.300622-2-alx.manpages@gmail.com> X-Mailer: git-send-email 2.29.2 In-Reply-To: <91ef6bdb-76db-ffdd-7d43-51d7abeb9beb@gmail.com> References: <91ef6bdb-76db-ffdd-7d43-51d7abeb9beb@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-man@vger.kernel.org From: Ganimedes Colomar 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 Cowritten-by: Alejandro Colomar Signed-off-by: Alejandro Colomar --- man2/add_key.2 | 3 ++- man2/arch_prctl.2 | 3 +++ man2/clone.2 | 2 +- man2/delete_module.2 | 2 +- man2/init_module.2 | 6 +----- man2/keyctl.2 | 3 ++- man2/pidfd_getfd.2 | 3 +++ man2/pidfd_open.2 | 3 +++ man2/pidfd_send_signal.2 | 2 ++ man2/request_key.2 | 3 ++- man2/s390_guarded_storage.2 | 3 +++ man2/s390_pci_mmio_write.2 | 3 +++ man2/s390_runtime_instr.2 | 3 +++ man2/s390_sthyi.2 | 3 +++ man2/seccomp.2 | 3 +++ man2/syslog.2 | 1 - 16 files changed, 35 insertions(+), 11 deletions(-) diff --git a/man2/add_key.2 b/man2/add_key.2 index 1476b7d85..7c20de777 100644 --- 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 97d5a2fe5..e8a6da391 100644 --- 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 0114668ea..0d6565b5d 100644 --- 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 daa15faa2..e63545d51 100644 --- 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 c2675db97..00cf4e948 100644 --- 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 6bf07972d..f37cae8df 100644 --- 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 1a69c8238..9312b6f92 100644 --- 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 5b99460e1..1b0c5e0d4 100644 --- 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 6670cf357..ffbfd1796 100644 --- 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 86f76e43d..6b041d0c4 100644 --- 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 b3aef858f..c3ab3bc85 100644 --- 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 802142987..2ccd630ab 100644 --- 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 558e9c99d..0f4a704de 100644 --- 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 2ff06051a..70871286b 100644 --- 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 6ac890a2f..4600c51d6 100644 --- 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 c6d6dcc94..133ba2121 100644 --- 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 " -- 2.29.2