* [PATCH] docs: kernel-doc: include "define" as an identifier type
@ 2026-09-12 5:52 Randy Dunlap
2026-09-15 19:01 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2026-09-12 5:52 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Jonathan Corbet, Shuah Khan, Mauro Carvalho Chehab,
linux-doc
Update the list of identifier types to include "define", which was
added in 2014 in commit
cbb4d3e6510b ("scripts/kernel-doc: handle object-like macros")
Fixes: 91a3d6be99e6 ("doc-guide: kernel-doc: tell about object-like macros")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: linux-doc@vger.kernel.org
Documentation/doc-guide/kernel-doc.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
--- linux-next-20260911.orig/Documentation/doc-guide/kernel-doc.rst
+++ linux-next-20260911/Documentation/doc-guide/kernel-doc.rst
@@ -565,8 +565,8 @@ identifiers: *[ function/type ...]*
Include documentation for each *function* and *type* in *source*.
If no *function* is specified, the documentation for all functions
and types in the *source* will be included.
- *type* can be a ``struct``, ``union``, ``enum``, ``typedef`` or ``var``
- identifier.
+ *type* can be a ``struct``, ``union``, ``enum``, ``typedef``, ``var``,
+ or ``define`` identifier.
Examples::
^ permalink raw reply [flat|nested] 2+ messages in thread* Re: [PATCH] docs: kernel-doc: include "define" as an identifier type
2026-09-12 5:52 [PATCH] docs: kernel-doc: include "define" as an identifier type Randy Dunlap
@ 2026-09-15 19:01 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2026-09-15 19:01 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel
Cc: Randy Dunlap, Shuah Khan, Mauro Carvalho Chehab, linux-doc
Randy Dunlap <rdunlap@infradead.org> writes:
> Update the list of identifier types to include "define", which was
> added in 2014 in commit
> cbb4d3e6510b ("scripts/kernel-doc: handle object-like macros")
>
> Fixes: 91a3d6be99e6 ("doc-guide: kernel-doc: tell about object-like macros")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
> Cc: linux-doc@vger.kernel.org
>
> Documentation/doc-guide/kernel-doc.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> --- linux-next-20260911.orig/Documentation/doc-guide/kernel-doc.rst
> +++ linux-next-20260911/Documentation/doc-guide/kernel-doc.rst
> @@ -565,8 +565,8 @@ identifiers: *[ function/type ...]*
> Include documentation for each *function* and *type* in *source*.
> If no *function* is specified, the documentation for all functions
> and types in the *source* will be included.
> - *type* can be a ``struct``, ``union``, ``enum``, ``typedef`` or ``var``
> - identifier.
> + *type* can be a ``struct``, ``union``, ``enum``, ``typedef``, ``var``,
> + or ``define`` identifier.
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-09-15 19:01 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-09-12 5:52 [PATCH] docs: kernel-doc: include "define" as an identifier type Randy Dunlap
2026-09-15 19:01 ` Jonathan Corbet
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®