Skip to contentSkip to conversation

arch: x86: Fixes Documentation warning

PATCH Applied Vincenzo Palazzo 2 participants 2 messages Aug 30, 2023 – Aug 31, 2023 x86

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 arch: x86: Fixes Documentation warning

This commit files the following warnings

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

---
 arch/x86/kernel/i8259.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)
arch/x86/kernel/i8259.c +1 -3
index 4d8aff05a509..30a55207c000 100644
@@ -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);
Signature · 1 line
2.42.0
#1 lore raw

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

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

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 <[email protected]>
AuthorDate:    Wed, 30 Aug 2023 15:12:09 +02:00
Committer:     Ingo Molnar <[email protected]>
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

---
 arch/x86/kernel/i8259.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)
arch/x86/kernel/i8259.c +1 -3
index 4d8aff0..30a5520 100644
@@ -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);