From patchwork Sat Apr 3 19:39:52 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 42843 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 403C2385E448; Sat, 3 Apr 2021 19:41:52 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 403C2385E448 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1617478912; bh=n6NQljeifzObYAimd/mHaMftDdhocyqwN9rXklsxEmM=; h=To:Subject:Date:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:Cc:From; b=qoAMKmlYMaElzPjjkll+sZVICQHVb0HF/DJ1VeVa4seXj/tq3TnOywa45mcBEJ7qn Qd/KerhdgmeTSKtFNEMs+h48542beTa/eNaDNUCvYifivKEeNEqBV7bVhqmqi7Btjg zOeSZ6ndGkRTsqawwycGF4Qmi+HjgwqjVeqPBebs= X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from mail-wm1-x32e.google.com (mail-wm1-x32e.google.com [IPv6:2a00:1450:4864:20::32e]) by sourceware.org (Postfix) with ESMTPS id F23F13858004 for ; Sat, 3 Apr 2021 19:41:48 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org F23F13858004 Received: by mail-wm1-x32e.google.com with SMTP id m20-20020a7bcb940000b029010cab7e5a9fso5745572wmi.3 for ; Sat, 03 Apr 2021 12:41:48 -0700 (PDT) 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:mime-version :content-transfer-encoding; bh=n6NQljeifzObYAimd/mHaMftDdhocyqwN9rXklsxEmM=; b=TZKwgqFDlwt+GevCrXSZJcL6tyJ+4scO/3QtCFMHFcnmyRODOh9MtJAEw9s/GVu9Cf EeHxWTBkHItoejUNP5hqU7gIO0nf5pCJKtQ8fP/SLk0jcpffcHVc3Wi8K4cXyTITlEKH snz2pLHIzbiue/+bgTbDOY9akE+aQeTiVhvW0EoS02zQ/iIgFlvJd/JrvO11nKwJXtnG 2+KaawIQzHBD/pcqcZxJ6lMrtyBQzxPPrkPaUrROUvj5DW0vn1SKPRJgPGROEC8Dzf6E 0AAtfVZdke/sn4DtXKtLDTp1z2BlDR2w6X3ebMDi4FpD3Tjj1AdmKZsmtO9ARANAJ89g YpaQ== X-Gm-Message-State: AOAM533X82ZobkS6EIn5dUnSqzWQwrXKD9p1xZQI+aYD0Jd8ktwbZFmI qllVHVSRQgt+5qDmqxsOEoU= X-Google-Smtp-Source: ABdhPJw0cemLU4WP1NVoyiFtAC77R9mmgJhXr9XWuzZZIIrNhO5JH5ddyDbBXj04xrpoTwkFsgE1Rw== X-Received: by 2002:a7b:c003:: with SMTP id c3mr3781456wmb.59.1617478907906; Sat, 03 Apr 2021 12:41:47 -0700 (PDT) Received: from localhost.localdomain ([170.253.36.171]) by smtp.googlemail.com with ESMTPSA id n1sm25211056wro.36.2021.04.03.12.41.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 03 Apr 2021 12:41:47 -0700 (PDT) To: mtk.manpages@gmail.com Subject: [PATCH v4 00/35] SYNOPSIS: Use syscall(SYS_...); and fix '#include's Date: Sat, 3 Apr 2021 21:39:52 +0200 Message-Id: <20210403194026.102818-1-alx.manpages@gmail.com> X-Mailer: git-send-email 2.31.0 MIME-Version: 1.0 X-Spam-Status: No, score=-5.8 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_FROM, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Alejandro Colomar via Libc-alpha From: Alejandro Colomar Reply-To: Alejandro Colomar Cc: Alejandro Colomar , linux-man@vger.kernel.org, libc-alpha@sourceware.org Errors-To: libc-alpha-bounces@sourceware.org Sender: "Libc-alpha" Hello Michael, I cleaned up the includes (add missing ones, remove unneeded ones, ...), explained why each of them is needed (except for the one providing the prototype), a few ffixes, and changed prototypes to use syscall() when there's no wrapper. I thought of adding a new section 'LIBRARY', as in FreeBSD's manual pages, instead of assuming glibc, and having non-standard clarifications in NOTES for non-glibc functions; but that would be for a future patch-set after this one. I highly doubt that I can finish this before 5.12, so maybe you prefer to start a new branch to not release 5.12 with a mix of styles...; up to you :-) I didn't separate the syscall() changes from the #include changes, because in most cases one implies the other, so I considered this as a SYNOPSIS general improvement. Cheers, Alex Alejandro Colomar (35): system_data_types.7: Add 'struct sockaddr' sockaddr.3: New link to system_data_types(7) system_data_types.7: Add 'socklen_t' socklen_t.3: New link to system_data_types(7) access.2: Use syscall(SYS_...); for system calls without a wrapper add_key.2: Remove unused include alloc_hugepages.2: Use syscall(SYS_...); for system calls without a wrapper arch_prctl.2: Use syscall(SYS_...); for system calls without a wrapper arch_prctl.2: SYNOPSIS: Remove unused includes capget.2: Use syscall(SYS_...); for system calls without a wrapper clone.2: Use syscall(SYS_...); for system calls without a wrapper delete_module.2: Add missing include dup.2: SYNOPSIS: Use consistent comments through pages execveat.2: Use syscall(SYS_...); for system calls without a wrapper exit_group.2: Use 'noreturn' in prototypes exit_group.2: Use syscall(SYS_...); for system calls without a wrapper fanotify_init.2: Add comment: why more than one include is needed fcntl.2: Remove unused include futex.2: Use syscall(SYS_...); for system calls without a wrapper futimesat.2: ffix getdents.2: Use syscall(SYS_...); for system calls without a wrapper getpriority.2: Remove unused include getrlimit.2, getrusage.2: Remove unused include getunwind.2: Use syscall(SYS_...); for system calls without a wrapper get_robust_list.2: Use syscall(SYS_...); for system calls without a wrapper delete_module.2: Use syscall(SYS_...); for system calls without a wrapper init_module.2: Use syscall(SYS_...); for system calls without a wrapper io_cancel.2: Use syscall(SYS_...); for system calls without a wrapper ioctl_fat.2: Make clear why is each header exactly needed. ioctl_fat.2: ffix ioctl_ficlonerange.2: Make clear why is each header exactly needed. ioctl_fideduperange.2: Make clear why exactly is each header needed ioctl_fslabel.2: ffix ioctl_fslabel.2: Make clear why exactly is each header needed ioctl_getfsmap.2: Make clear why exactly is each header needed man2/access.2 | 11 +++++--- man2/add_key.2 | 1 - man2/alloc_hugepages.2 | 7 ++--- man2/arch_prctl.2 | 15 ++++------- man2/capget.2 | 20 +++++++------- man2/clone.2 | 17 +++++------- man2/delete_module.2 | 9 ++++--- man2/dup.2 | 2 +- man2/execveat.2 | 14 ++++------ man2/exit_group.2 | 5 ++-- man2/fanotify_init.2 | 2 +- man2/fcntl.2 | 1 - man2/futex.2 | 19 +++++--------- man2/futimesat.2 | 2 +- man2/get_robust_list.2 | 19 ++++++-------- man2/getdents.2 | 12 ++++++--- man2/getpriority.2 | 13 ---------- man2/getrlimit.2 | 1 - man2/getrusage.2 | 9 ------- man2/getunwind.2 | 14 +++------- man2/init_module.2 | 20 ++++++-------- man2/io_cancel.2 | 16 +++++------- man2/ioctl_fat.2 | 7 ++--- man2/ioctl_ficlonerange.2 | 2 +- man2/ioctl_fideduperange.2 | 3 ++- man2/ioctl_fslabel.2 | 4 +-- man2/ioctl_getfsmap.2 | 4 +-- man3/sockaddr.3 | 1 + man3/socklen_t.3 | 1 + man7/system_data_types.7 | 53 ++++++++++++++++++++++++++++++++++++++ 30 files changed, 156 insertions(+), 148 deletions(-) create mode 100644 man3/sockaddr.3 create mode 100644 man3/socklen_t.3