From: Matthew Wilcox <willy@infradead.org>
To: Frederick Mayle <fmayle@google.com>
Cc: android-mm@google.com, kernel-team@android.com,
Jan Kara <jack@suse.cz>,
Andrew Morton <akpm@linux-foundation.org>,
linux-fsdevel@vger.kernel.org, linux-mm@kvack.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/2] mm/readahead: add kerneldoc for read_pages
Date: Tue, 12 May 2026 22:05:34 +0100 [thread overview]
Message-ID: <agOWHm00w2vlh1_o@casper.infradead.org> (raw)
In-Reply-To: <20260512203154.754075-2-fmayle@google.com>
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.
next prev parent reply other threads:[~2026-05-12 21:05 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-12 20:31 [PATCH 0/2] mm: document read_pages and simplify usage Frederick Mayle
2026-05-12 20:31 ` [PATCH 1/2] mm/readahead: add kerneldoc for read_pages Frederick Mayle
2026-05-12 21:05 ` Matthew Wilcox [this message]
2026-05-13 2:14 ` Andrew Morton
2026-05-12 20:31 ` [PATCH 2/2] mm/readahead: simplify page_cache_ra_unbounded loop counter reset Frederick Mayle
2026-05-12 20:37 ` [PATCH 0/2] mm: document read_pages and simplify usage Frederick Mayle
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=agOWHm00w2vlh1_o@casper.infradead.org \
--to=willy@infradead.org \
--cc=akpm@linux-foundation.org \
--cc=android-mm@google.com \
--cc=fmayle@google.com \
--cc=jack@suse.cz \
--cc=kernel-team@android.com \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.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