Re: [PATCH 1/2] mm/readahead: add kerneldoc for read_pages

From: Matthew Wilcox

Date: Tue May 12 2026 - 17:06:57 EST


On Tue, May 12, 2026 at 01:31:35PM -0700, Frederick Mayle wrote:
> Formalize one of the invariants provided by the current implementation
> so that callers can depend on it, as discussed in [1].

We don't normally write kerneldoc for static functions. I'm not sure
why Andrew told you to do this. I have no objection to adding
documentation, but I don't think it should be marked as kerneldoc.
And if it's not kerneldoc, it doesn't have to be written in such a
stifling style.