2024-01-04 01:33:30

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] x86/apic: don't use kernel-doc for IDTENTRY functions

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 <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Cc: Ingo Molnar <[email protected]>
Cc: Borislav Petkov <[email protected]>
Cc: Dave Hansen <[email protected]>
Cc: [email protected]
Cc: Jonathan Corbet <[email protected]>
---
arch/x86/kernel/apic/apic.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

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