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

Andy Shevchenko posted 2 patches 1 month, 1 week ago
[PATCH v1 2/2] x86/apic: Update kernel-doc to avoid warnings
Posted by Andy Shevchenko 1 month, 1 week ago
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@linux.intel.com>
---
 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
-- 
2.50.1
Re: [PATCH v1 2/2] x86/apic: Update kernel-doc to avoid warnings
Posted by Randy Dunlap 1 month, 1 week ago

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@linux.intel.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.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