Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
MIME-Version: 1.0
References: <20220829030521.3373516-1-ammar.faizi@intel.com> <20220829030521.3373516-4-ammar.faizi@intel.com>
In-Reply-To: <20220829030521.3373516-4-ammar.faizi@intel.com>
From:   Caleb Sander <csander@purestorage.com>
Date:   Mon, 29 Aug 2022 12:56:27 -0700
Message-ID: <CADUfDZrEANpxTZ4y0F7sY2XW-9Arnix=M_xt132eBLs6NFwFCQ@mail.gmail.com>
Subject: Re: [RFC PATCH liburing v1 3/4] man: Alias `io_uring_enter2()` to `io_uring_enter()`
To:     Ammar Faizi <ammarfaizi2@gnuweeb.org>
Cc:     Jens Axboe <axboe@kernel.dk>, Muhammad Rizki <kiizuha@gnuweeb.org>,
        Kanna Scarlet <knscarlet@gnuweeb.org>,
        io-uring Mailing List <io-uring@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        "GNU/Weeb Mailing List" <gwml@vger.gnuweeb.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

There is no reference to "io_uring_enter2()" in this man page, only to
the updated signature of "io_uring_enter()". Can we make it clearer
that this is "io_uring_enter2()"? I would suggest adding the signature
for io_uring_enter2() to the top of the man page and renaming
"io_uring_enter()" to "io_uring_enter2()" in the "Since kernel 5.11"
section.

On Sun, Aug 28, 2022 at 8:08 PM Ammar Faizi <ammarfaizi2@gnuweeb.org> wrote:
>
> From: Ammar Faizi <ammarfaizi2@gnuweeb.org>
>
> We have a new function io_uring_enter2(), add the man page entry for it
> by aliasing it to io_uring_enter(). This aliased man entry has already
> explained it.
>
> Cc: Caleb Sander <csander@purestorage.com>
> Signed-off-by: Ammar Faizi <ammarfaizi2@gnuweeb.org>
> ---
>  man/io_uring_enter2.2 | 1 +
>  1 file changed, 1 insertion(+)
>  create mode 120000 man/io_uring_enter2.2
>
> diff --git a/man/io_uring_enter2.2 b/man/io_uring_enter2.2
> new file mode 120000
> index 0000000..5566c09
> --- /dev/null
> +++ b/man/io_uring_enter2.2
> @@ -0,0 +1 @@
> +io_uring_enter.2
> \ No newline at end of file
> --
> Ammar Faizi
>