From: "NeilBrown" <neilb@suse.de>
To: "Matthew Wilcox" <willy@infradead.org>
Cc: "Mike Rapoport" <rppt@kernel.org>,
lsf-pc@lists.linux-foundation.org, linux-fsdevel@vger.kernel.org,
linux-mm@kvack.org, linux-block@vger.kernel.org,
linux-ide@vger.kernel.org, linux-scsi@vger.kernel.org,
linux-nvme@lists.infradead.org, bpf@vger.kernel.org
Subject: Re: [LSF/MM/BPF TOPIC] Reclaiming & documenting page flags
Date: Tue, 20 Feb 2024 09:45:36 +1100 [thread overview]
Message-ID: <170838273655.1530.946393725104206593@noble.neil.brown.name> (raw)
In-Reply-To: <ZdO2eABfGoPNnR07@casper.infradead.org>
On Tue, 20 Feb 2024, Matthew Wilcox wrote:
> On Wed, Feb 07, 2024 at 05:51:44PM +0200, Mike Rapoport wrote:
> > On Sun, Feb 04, 2024 at 09:34:01PM +0000, Matthew Wilcox wrote:
> > > I'm doing my best to write documentation as I go. I think we're a bit
> > > better off than we were last year. Do we have scripts to tell us which
> > > public functions (ie EXPORT_SYMBOL and static inline functions in header
> > > files) have kernel-doc? And could we run them against kernels from, say,
> > > April 2023, 2022, 2021, 2020, 2019 (and in two months against April 2024)
> > > and see how we're doing in terms of percentage undocumented functions?
> >
> > We didn't have such script, but it was easy to compare "grep
> > EXPORT_SYMBOL\|static inline" with ".. c:function" in kernel-doc.
> > We do improve slowly, but we are still below 50% with kernel-doc for
> > EXPORT_SYMBOL functions and slightly above 10% for static inlines.
>
> Thanks for doing this! Data is good ;-)
>
> I just came across an interesting example of a function which I believe
> should NOT have kernel-doc. But it should have documentation for why it
> doesn't have kernel-doc! Any thoughts about how we might accomplish that?
>
> The example is filemap_range_has_writeback(). It's EXPORT_SYMBOL_GPL()
> and it's a helper function for filemap_range_needs_writeback().
> filemap_range_needs_writeback() has kernel-doc, but nobody should be
> calling filemap_range_has_writeback() directly, so it shouldn't even
> exist in the htmldocs. But we should have a comment on it saying
> "Use filemap_range_needs_writeback(), don't use this", in case anyone
> discovers it. And the existance of that comment should be enough to
> tell our tools to not flag this as a function that needs kernel-doc.
>
Don't we use a __prefix for internal stuff that shouldn't be used?
NeilBrown
next prev parent reply other threads:[~2024-02-19 22:45 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-29 4:32 [LSF/MM/BPF TOPIC] Reclaiming & documenting page flags Matthew Wilcox
2024-02-02 16:28 ` Matthew Wilcox
2024-02-04 10:39 ` Mike Rapoport
2024-02-04 21:34 ` Matthew Wilcox
2024-02-07 15:51 ` Mike Rapoport
2024-02-19 20:13 ` Matthew Wilcox
2024-02-19 22:45 ` NeilBrown [this message]
2024-02-19 23:29 ` Matthew Wilcox
2024-02-20 0:21 ` NeilBrown
2024-02-20 7:16 ` Hannes Reinecke
2024-02-17 11:57 ` Muhammad Usama Anjum
2024-05-17 21:32 ` Navid
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=170838273655.1530.946393725104206593@noble.neil.brown.name \
--to=neilb@suse.de \
--cc=bpf@vger.kernel.org \
--cc=linux-block@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-ide@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=linux-nvme@lists.infradead.org \
--cc=linux-scsi@vger.kernel.org \
--cc=lsf-pc@lists.linux-foundation.org \
--cc=rppt@kernel.org \
--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 read-only IMAP folder(s) and NNTP newsgroup(s).