From: Jonathan Corbet <corbet@lwn.net>
To: Matthew Wilcox <willy@infradead.org>
Cc: Randy Dunlap <rdunlap@infradead.org>,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
Andrew Morton <akpm@linux-foundation.org>,
Suren Baghdasaryan <surenb@google.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: Re: [PATCH] scripts/kernel-doc: drop "_noprof" on function prototypes
Date: Thu, 05 Jun 2025 13:52:36 -0600 [thread overview]
Message-ID: <871pryezjv.fsf@trenco.lwn.net> (raw)
In-Reply-To: <aEHwdoNCrF4-KY_i@casper.infradead.org>
Matthew Wilcox <willy@infradead.org> writes:
> kernel-doc is our own format, so sure, we can add whatever marker
> we want to it. I think it's not quite general enough because we have
> situations like:
>
> static inline void foo(int x)
> {
> numa_foo(x, NUMA_NO_NODE);
> };
>
> /**
> * foo - Frobnicate
> * @x: How many
> * @nid: Which node
> */
> void numa_foo(int x, int node)
> { .. }
>
> and now we're documenting a parameter that doesn't exist. The only
> solution is to move the kdoc to the header file, which is annoying for
> everyone. Or replicate the declaration in the C file and kdoc it there.
In this case, though, is there a reason to not document foo() as a
separate function?
jon
next prev parent reply other threads:[~2025-06-05 19:52 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-26 5:41 Randy Dunlap
2024-03-26 20:35 ` Suren Baghdasaryan
2025-06-05 19:07 ` Matthew Wilcox
2025-06-05 19:18 ` Jonathan Corbet
2025-06-05 19:31 ` Matthew Wilcox
2025-06-05 19:52 ` Jonathan Corbet [this message]
2025-06-05 22:50 ` Mauro Carvalho Chehab
2025-06-05 23:28 ` Mauro Carvalho Chehab
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=871pryezjv.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=akpm@linux-foundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@kernel.org \
--cc=rdunlap@infradead.org \
--cc=surenb@google.com \
--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
all inboxes | Powered by JetHome®