Re: [PATCH v5 6/6] docs: fuse: document io-uring buffer pool and zero-copy uapi

Joanne Koong <[email protected]> Wed, 1 Jul 2026 09:35:29 -0700
Newsgroups dev.linux.lists.fuse-devel
Message-ID <CAJnrk1YT+a-NJ3H8rGziAPb9QL5-Qa4A-ojLmz8jSmWKPoJEnw@mail.gmail.com>
On Wed, Jul 1, 2026 at 4:56 AM Amir Goldstein <[email protected]> wrote:
>
> On Tue, Jun 30, 2026 at 11:17 PM Joanne Koong <[email protected]> wrote:
> >
> > Add documentation for fuse over io-uring usage of buffer pools and
> > zero-copy.
> >
> > Signed-off-by: Joanne Koong <[email protected]>
> > ---
> >  .../filesystems/fuse/fuse-io-uring.rst        |   5 +-
> >  Documentation/filesystems/fuse/index.rst      |   1 +
> >  .../filesystems/fuse/uapi/io-uring.rst        | 143 ++++++++++++++++++
> >  3 files changed, 148 insertions(+), 1 deletion(-)
> >  create mode 100644 Documentation/filesystems/fuse/uapi/io-uring.rst
> >
> > diff --git a/Documentation/filesystems/fuse/fuse-io-uring.rst b/Documentation/filesystems/fuse/fuse-io-uring.rst
> > index d73dd0dbd238..a92dee057d78 100644
> > --- a/Documentation/filesystems/fuse/fuse-io-uring.rst
> > +++ b/Documentation/filesystems/fuse/fuse-io-uring.rst
> > @@ -95,5 +95,8 @@ Sending requests with CQEs
> >   |    <fuse_unlink()                         |
> >   |  <sys_unlink()                            |
> >
> > -
> > +Buffer pools and zero-copy
> > +==========================
> > +For the userspace protocol used to set up buffer pools and zero-copy, see
> > +Documentation/filesystems/fuse/uapi/io-uring.rst.
>
> This dereference is not clear to me.
>
> The name of the suggested doc is even more puzzling for me
> io-uring.rst is really not an adequest standalone name for this doc
> and fuse/uapi path is unconventional in Documentation.
> The doc is not even pure uapi, it explains about buffer pools and zero copy.
>
> Why not include the details inline in fuse-io-uring.rst?
> It's not going to be a huge doc and all details seem to be intertwined.

The details were originally in fuse-io-uring.rst but I think Miklos
preferred having a separate fuse/uapi directory [1] for how userspace
interacts with it.

I'm happy to change the name of the suggested doc - is there an
alternative name you'd prefer more? How do you suggest making the
dereference clearer?

Thanks,
Joanne

[1] https://lore.kernel.org/fuse-devel/CAJfpegt8sfO681aoixfCc2XvUP-OH50GVHG-vmF8Q3oGqxF9MA@mail.gmail.com/#t