linux-kernel - [tip: x86/urgent] x86/irq/i8259: Fix kernel-doc annotation warning

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-prev] [day] [month] [year] [list]

Message-ID: <169350796885.27769.16966802994476082698.tip-bot2@tip-bot2>
Date:   Thu, 31 Aug 2023 18:52:48 -0000
From:   "tip-bot2 for Vincenzo Palazzo" <tip-bot2@...utronix.de>
To:     linux-tip-commits@...r.kernel.org
Cc:     Vincenzo Palazzo <vincenzopalazzodev@...il.com>,
        Ingo Molnar <mingo@...nel.org>, x86@...nel.org,
        linux-kernel@...r.kernel.org
Subject: [tip: x86/urgent] x86/irq/i8259: Fix kernel-doc annotation warning

The following commit has been merged into the x86/urgent branch of tip:

Commit-ID:     d87e89c2735772fbed933be0d19e032c1910a51f
Gitweb:        https://git.kernel.org/tip/d87e89c2735772fbed933be0d19e032c1910a51f
Author:        Vincenzo Palazzo <vincenzopalazzodev@...il.com>
AuthorDate:    Wed, 30 Aug 2023 15:12:09 +02:00
Committer:     Ingo Molnar <mingo@...nel.org>
CommitterDate: Thu, 31 Aug 2023 20:43:30 +02:00

x86/irq/i8259: Fix kernel-doc annotation warning

Fix this warning:

  arch/x86/kernel/i8259.c:235: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
   * ELCR registers (0x4d0, 0x4d1) control edge/level of IRQ
    CC      arch/x86/kernel/irqinit.o

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@...il.com>
Signed-off-by: Ingo Molnar <mingo@...nel.org>
Link: https://lore.kernel.org/r/20230830131211.88226-1-vincenzopalazzodev@gmail.com
---
 arch/x86/kernel/i8259.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/arch/x86/kernel/i8259.c b/arch/x86/kernel/i8259.c
index 4d8aff0..30a5520 100644
--- a/arch/x86/kernel/i8259.c
+++ b/arch/x86/kernel/i8259.c
@@ -231,9 +231,7 @@ struct irq_chip i8259A_chip = {
 };
 
 static char irq_trigger[2];
-/**
- * ELCR registers (0x4d0, 0x4d1) control edge/level of IRQ
- */
+/* ELCR registers (0x4d0, 0x4d1) control edge/level of IRQ */
 static void restore_ELCR(char *trigger)
 {
 	outb(trigger[0], PIC_ELCR1);