Documentation/doc-guide/kernel-doc.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
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::
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
© 2016 - 2026 Red Hat, Inc.