From patchwork Mon Aug 29 03:07:37 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ammar Faizi X-Patchwork-Id: 12957411 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A1042ECAAA2 for ; Mon, 29 Aug 2022 03:08:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229770AbiH2DIi (ORCPT ); Sun, 28 Aug 2022 23:08:38 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41910 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229786AbiH2DIY (ORCPT ); Sun, 28 Aug 2022 23:08:24 -0400 Received: from gnuweeb.org (gnuweeb.org [51.81.211.47]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 141EF3ECDF; Sun, 28 Aug 2022 20:08:06 -0700 (PDT) Received: from localhost.localdomain (unknown [182.2.68.216]) by gnuweeb.org (Postfix) with ESMTPSA id 237D280B1A; Mon, 29 Aug 2022 03:07:55 +0000 (UTC) X-GW-Data: lPqxHiMPbJw1wb7CM9QUryAGzr0yq5atzVDdxTR0iA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gnuweeb.org; s=default; t=1661742478; bh=ivRuXH0B3moNqjOeBRddyAEgMfDZLseE8xHqimkLSzw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=SnVr8pfap+KMag0EwUAcZvK37dpAYosZgdNjT/f6VBMnFqvp2jLLxM6p109CKyT/f irZY0E07TiRlZacarpNfe90b22sk0uMFSXRWof7RocUzLwLu+t7OtqTynIKSMHnAaA Pm98zLlA8/O9MBv3CTdkG8nkbQBkvp+T8EqwPw0POpMRZaI3OcCAsTD1T4pw70OKBM oc4u0vRGufHPz+GvmTnnfR3bJOy0CuSxsYIC+4CteEwuj3Rj7G4O7hosTSj6qOdqYq zWWP2ofTY7xAlc/YPVpkt90joDawe/IdevvOX/UfOg40eojqUxQcfVEJkdSd5bO0B1 CwHSwEXweHgTQ== From: Ammar Faizi To: Jens Axboe Cc: Ammar Faizi , Caleb Sander , Muhammad Rizki , Kanna Scarlet , io-uring Mailing List , Linux Kernel Mailing List , GNU/Weeb Mailing List Subject: [RFC PATCH liburing v1 2/4] man: Clarify "man 2" entry for io_uring syscalls Date: Mon, 29 Aug 2022 10:07:37 +0700 Message-Id: <20220829030521.3373516-3-ammar.faizi@intel.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220829030521.3373516-1-ammar.faizi@intel.com> References: <20220829030521.3373516-1-ammar.faizi@intel.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: io-uring@vger.kernel.org From: Ammar Faizi io_uring_enter(), io_uring_register(), io_uring_setup() are not declared in `` and never were. Plus, these functions don't intentionally set the `errno` variable. Reflect this fact in the manpage. Side note: On architectures other than x86, x86-64, and aarch64, those functions _do_ set the `errno`, this is because the syscall is done via libc as we don't yet have nolibc support for the mentioned archs. Users should not rely on this behavior. Cc: Caleb Sander Signed-off-by: Ammar Faizi --- man/io_uring_enter.2 | 9 ++++----- man/io_uring_register.2 | 9 ++++----- man/io_uring_setup.2 | 8 +++----- 3 files changed, 11 insertions(+), 15 deletions(-) diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2 index 6bfe9c9..05f9f72 100644 --- a/man/io_uring_enter.2 +++ b/man/io_uring_enter.2 @@ -8,7 +8,7 @@ io_uring_enter \- initiate and/or complete asynchronous I/O .SH SYNOPSIS .nf -.BR "#include " +.BR "#include " .PP .BI "int io_uring_enter(unsigned int " fd ", unsigned int " to_submit , .BI " unsigned int " min_complete ", unsigned int " flags , @@ -1299,11 +1299,10 @@ completion queue entry (see section rather than through the system call itself. Errors that occur not on behalf of a submission queue entry are returned via the -system call directly. On such an error, -.B -1 -is returned and +system call directly. On such an error, a negative error code is returned. The +caller should not rely on .I errno -is set appropriately. +variable. .PP .SH ERRORS These are the errors returned by diff --git a/man/io_uring_register.2 b/man/io_uring_register.2 index 6c440b9..6791375 100644 --- a/man/io_uring_register.2 +++ b/man/io_uring_register.2 @@ -8,7 +8,7 @@ io_uring_register \- register files or user buffers for asynchronous I/O .SH SYNOPSIS .nf -.BR "#include " +.BR "#include " .PP .BI "int io_uring_register(unsigned int " fd ", unsigned int " opcode , .BI " void *" arg ", unsigned int " nr_args ); @@ -583,11 +583,10 @@ Available since 5.18. On success, .BR io_uring_register () -returns 0. On error, -.B -1 -is returned, and +returns 0. On error, a negative error code is returned. The caller should not +rely on .I errno -is set accordingly. +variable. .SH ERRORS .TP diff --git a/man/io_uring_setup.2 b/man/io_uring_setup.2 index 0a5fa92..32a9e2e 100644 --- a/man/io_uring_setup.2 +++ b/man/io_uring_setup.2 @@ -9,7 +9,7 @@ io_uring_setup \- setup a context for performing asynchronous I/O .SH SYNOPSIS .nf -.BR "#include " +.BR "#include " .PP .BI "int io_uring_setup(u32 " entries ", struct io_uring_params *" p ); .fi @@ -566,11 +566,9 @@ or .BR io_uring_enter (2) system calls. -On error, -.B -1 -is returned and +On error, a negative error code is returned. The caller should not rely on .I errno -is set appropriately. +variable. .PP .SH ERRORS .TP