linux-kernel - Re: [PATCH v1 2/2] x86/apic: Update kernel-doc to avoid warnings

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: <7d03b0d2-8dd8-4cda-8a0d-7a065029e6f5@infradead.org>
Date: Fri, 7 Nov 2025 16:47:25 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
 Jonathan Corbet <corbet@....net>,
 Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
 linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org
Cc: 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, "H. Peter Anvin" <hpa@...or.com>
Subject: Re: [PATCH v1 2/2] x86/apic: Update kernel-doc to avoid warnings



On 11/6/25 2:12 AM, Andy Shevchenko wrote:
> Validator is not happy about some of the kernel-doc descriptions:
> 
> Warning: arch/x86/kernel/apic/apic.c:245 No description found for return value of 'lapic_get_maxlvt'
> Warning: arch/x86/kernel/apic/apic.c:2145 function parameter 'error_code' not described in 'spurious_interrupt'
> 
> Update them accordingly.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

> ---
>  arch/x86/kernel/apic/apic.c | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/arch/x86/kernel/apic/apic.c b/arch/x86/kernel/apic/apic.c
> index 680d305589a3..4675d1a07fc9 100644
> --- a/arch/x86/kernel/apic/apic.c
> +++ b/arch/x86/kernel/apic/apic.c
> @@ -241,6 +241,8 @@ u64 native_apic_icr_read(void)
>  
>  /**
>   * lapic_get_maxlvt - get the maximum number of local vector table entries
> + *
> + * Return: the maximum number of local vector table entries
>   */
>  int lapic_get_maxlvt(void)
>  {
> @@ -2136,7 +2138,7 @@ static noinline void handle_spurious_interrupt(u8 vector)
>  /**
>   * spurious_interrupt - Catch all for interrupts raised on unused vectors
>   * @regs:	Pointer to pt_regs on stack
> - * @vector:	The vector number
> + * @error_code:	The vector number
>   *
>   * This is invoked from ASM entry code to catch all interrupts which
>   * trigger on an entry which is routed to the common_spurious idtentry

-- 
~Randy