diff mbox series

x86/apic: don't use kernel-doc for IDTENTRY functions

Message ID 20240104013301.14458-1-rdunlap@infradead.org
State New
Headers
Series x86/apic: don't use kernel-doc for IDTENTRY functions |

Commit Message

Randy Dunlap Jan. 4, 2024, 1:33 a.m. UTC 
  scripts/kernel-doc doesn't handle DEFINE_IDTENTRY*() variants
so it prints a warning when processing them.

In order to reduce/remove kernel-doc warnings from the kernel, don't
use kernel-doc notation for DEFINE_IDTENTRY*() function comments.
This brings the apic.c usage in line with the more than 50 other
uses of DEFINE_IDTENTRY*() in the kernel.

This prevents one warning:

arch/x86/kernel/apic/apic.c:2170: warning: expecting prototype for spurious_interrupt(). Prototype was for DEFINE_IDTENTRY_IRQ() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Borislav Petkov <bp@alien8.de>
Cc: Dave Hansen <dave.hansen@linux.intel.com>
Cc: x86@kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
---
 arch/x86/kernel/apic/apic.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff -- a/arch/x86/kernel/apic/apic.c b/arch/x86/kernel/apic/apic.c
--- a/arch/x86/kernel/apic/apic.c
+++ b/arch/x86/kernel/apic/apic.c
@@ -2157,7 +2157,7 @@  out:
 	trace_spurious_apic_exit(vector);
 }
 
-/**
+/*
  * spurious_interrupt - Catch all for interrupts raised on unused vectors
  * @regs:	Pointer to pt_regs on stack
  * @vector:	The vector number