* [PATCH] irqchip/irq-omap-intc: fix kernel-doc syntax in file header
@ 2021-05-18 18:23 Aditya Srivastava
2021-05-18 18:44 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Aditya Srivastava @ 2021-05-18 18:23 UTC (permalink / raw)
To: linux-kernel
Cc: yashsri421, lukas.bulwahn, rdunlap, linux-kernel-mentees,
linux-doc, akpm, grandmaster, keescook
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for include/linux/irqchip/irq-omap-intc.h follows this syntax,
but the content inside does not comply with kernel-doc.
This line was probably not meant for kernel-doc parsing, but is parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warning from kernel-doc:
warning: expecting prototype for irq(). Prototype was for __INCLUDE_LINUX_IRQCHIP_IRQ_OMAP_INTC_H() instead
Provide a simple fix by replacing this occurrence with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
include/linux/irqchip/irq-omap-intc.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/irqchip/irq-omap-intc.h b/include/linux/irqchip/irq-omap-intc.h
index dca379c0d7eb..e31057e26a00 100644
--- a/include/linux/irqchip/irq-omap-intc.h
+++ b/include/linux/irqchip/irq-omap-intc.h
@@ -1,5 +1,5 @@
/* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
* irq-omap-intc.h - INTC Idle Functions
*
* Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com
--
2.17.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] irqchip/irq-omap-intc: fix kernel-doc syntax in file header
2021-05-18 18:23 [PATCH] irqchip/irq-omap-intc: fix kernel-doc syntax in file header Aditya Srivastava
@ 2021-05-18 18:44 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2021-05-18 18:44 UTC (permalink / raw)
To: Aditya Srivastava, linux-kernel
Cc: lukas.bulwahn, linux-kernel-mentees, linux-doc, akpm, grandmaster,
keescook
On 5/18/21 11:23 AM, Aditya Srivastava wrote:
>
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
>
> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
> ---
> include/linux/irqchip/irq-omap-intc.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
--
~Randy
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-05-18 18:45 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-05-18 18:23 [PATCH] irqchip/irq-omap-intc: fix kernel-doc syntax in file header Aditya Srivastava
2021-05-18 18:44 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).