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

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

Message-ID: <20240104013301.14458-1-rdunlap@infradead.org>
Date: Wed,  3 Jan 2024 17:33:01 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Thomas Gleixner <tglx@...utronix.de>,
	Ingo Molnar <mingo@...hat.com>,
	Borislav Petkov <bp@...en8.de>,
	Dave Hansen <dave.hansen@...ux.intel.com>,
	x86@...nel.org,
	Jonathan Corbet <corbet@....net>
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 <rdunlap@...radead.org>
Cc: Thomas Gleixner <tglx@...utronix.de>
Cc: Ingo Molnar <mingo@...hat.com>
Cc: Borislav Petkov <bp@...en8.de>
Cc: Dave Hansen <dave.hansen@...ux.intel.com>
Cc: x86@...nel.org
Cc: Jonathan Corbet <corbet@....net>
---
 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