linux-kernel - [PATCH] irqchip/irq-omap-intc: fix kernel-doc syntax in file header

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 18 May 2021 23:53:10 +0530
From:   Aditya Srivastava <yashsri421@...il.com>
To:     linux-kernel@...r.kernel.org
Cc:     yashsri421@...il.com, lukas.bulwahn@...il.com,
        rdunlap@...radead.org,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-doc@...r.kernel.org, akpm@...ux-foundation.org,
        grandmaster@...klimov.de, keescook@...omium.org
Subject: [PATCH] irqchip/irq-omap-intc: fix kernel-doc syntax in file header

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@...il.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