From: David Howells <dhowells@redhat.com>
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
Date: Mon, 20 Sep 2021 13:47:04 +0100 [thread overview]
Message-ID: <2950844.1632142024@warthog.procyon.org.uk> (raw)
In-Reply-To: <YUiAmnMV7+fprNC1@casper.infradead.org>
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 = {
> >
> > /**
> > * 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
next prev parent reply other threads:[~2021-09-20 12:47 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-20 12:14 [RFC PATCH] fscache, 9p, afs, cifs, nfs: Deal with some warnings from W=1 David Howells
2021-09-20 12:37 ` Matthew Wilcox
2021-09-20 12:47 ` David Howells [this message]
2021-09-20 13:02 ` Dominique Martinet
2021-09-20 17:59 ` Steve French
2021-09-20 18:16 ` David Howells
2021-09-23 19:08 ` Fwd: " Steve French
2021-09-28 8:46 ` David Howells
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2950844.1632142024@warthog.procyon.org.uk \
--to=dhowells@redhat.com \
--cc=anna.schumaker@netapp.com \
--cc=asmadeus@codewreck.org \
--cc=jlayton@kernel.org \
--cc=linux-afs@lists.infradead.org \
--cc=linux-cifs@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-nfs@vger.kernel.org \
--cc=marc.dionne@auristor.com \
--cc=mchehab@kernel.org \
--cc=sfrench@samba.org \
--cc=trond.myklebust@hammerspace.com \
--cc=v9fs-developer@lists.sourceforge.net \
--cc=willy@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).