Received-SPF: pass (google.com: domain of linux-nfs-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Organization: Red Hat UK Ltd. Registered Address: Red Hat UK Ltd, Amberley
        Place, 107-111 Peascod Street, Windsor, Berkshire, SI4 1TE, United
        Kingdom.
        Registered in England and Wales under Company Registration No. 3798903
From:   David Howells <dhowells@redhat.com>
In-Reply-To: <YUiAmnMV7+fprNC1@casper.infradead.org>
References: <YUiAmnMV7+fprNC1@casper.infradead.org> <163214005516.2945267.7000234432243167892.stgit@warthog.procyon.org.uk>
To:     Matthew Wilcox <willy@infradead.org>
Cc:     dhowells@redhat.com, linux-fsdevel@vger.kernel.org,
        Jeff Layton <jlayton@kernel.org>,
        Dominique Martinet <asmadeus@codewreck.org>,
        Marc Dionne <marc.dionne@auristor.com>,
        Steve French <sfrench@samba.org>,
        Trond Myklebust <trond.myklebust@hammerspace.com>,
        Anna Schumaker <anna.schumaker@netapp.com>,
        Mauro Carvalho Chehab <mchehab@kernel.org>,
        v9fs-developer@lists.sourceforge.net,
        linux-afs@lists.infradead.org, linux-cifs@vger.kernel.org,
        linux-nfs@vger.kernel.org, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: Re: [RFC PATCH] fscache, 9p, afs, cifs, nfs: Deal with some warnings from W=1
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-ID: <2950843.1632142024.1@warthog.procyon.org.uk>
Content-Transfer-Encoding: quoted-printable
Date:   Mon, 20 Sep 2021 13:47:04 +0100
Message-ID: <2950844.1632142024@warthog.procyon.org.uk>
Precedence: bulk

Matthew Wilcox <willy@infradead.org> wrote:

> > +++ b/fs/9p/vfs_addr.c
> > @@ -88,7 +88,7 @@ static const struct netfs_read_request_ops v9fs_req_=
ops =3D {
> >  =

> >  /**
> >   * v9fs_vfs_readpage - read an entire page in from 9P
> > - * @filp: file being read
> > + * @file: file being read
> >   * @page: structure to page
> >   *
> >   */
> =

> This is an example of a weird pattern in filesystems.  Several of
> them have kernel-doc for the implementation of various ->ops methods.
> I don't necessarily believe we should delete the comments (although is
> there any useful information in the above?), but I don't see the point
> in the comment being kernel-doc.

Yeah - I would prefer to do that.  Only kdoc it if it's inter-(sub-)driver=
 API
- and if it is, it must have a namespacing prefix so that it is obvious in
amongst a kernel-wide general index.

David