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

On Wed, Jul 1, 2026 at 6:35 PM Joanne Koong <[email protected]> wrote:
>
> 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.

My reading of this comment is that we ALSO need a uAPI document
not move the buffer pool overview into the uAPI document.

>
> 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?

Either document commands and structs in fuse-uapi.rst
(as a placeholder for more commands documentation) or in
fuse-uapi-io-uring.rst.
can be under fuse/uapi/ if this feels more organized.
My point is that doc names can be self describing and I find it better this way.

But I don't think that the overview of buffer pools and zero copy belongs there.
I think they are still very much useful in the fuse-io-uring.rst design doc
as in v4 and I do not think that Miklos objected to this point.

Thanks,
Amir.