2023-12-16 19:50:15

by Randy Dunlap

Subject: [PATCH] x86/usercopy: fix kernel-doc function param name

Correct the function parameter name in clean_cache_range() to prevent
kernel-doc warnings:

usercopy_64.c:29: warning: Function parameter or member 'addr' not described in 'clean_cache_range'
usercopy_64.c:29: warning: Excess function parameter 'vaddr' description in 'clean_cache_range'

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]
---
arch/x86/lib/usercopy_64.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/arch/x86/lib/usercopy_64.c b/arch/x86/lib/usercopy_64.c
--- a/arch/x86/lib/usercopy_64.c
+++ b/arch/x86/lib/usercopy_64.c
@@ -18,7 +18,7 @@
#ifdef CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE
/**
* clean_cache_range - write back a cache range with CLWB
- * @vaddr: virtual start address
+ * @addr: virtual start address
* @size: number of bytes to write back
*
* Write back a cache range using the CLWB (cache line write back)

2023-12-18 11:46:35

by Sohil Mehta

Subject: Re: [PATCH] x86/usercopy: fix kernel-doc function param name

On 12/17/2023 1:20 AM, Randy Dunlap wrote:
> Correct the function parameter name in clean_cache_range() to prevent
> kernel-doc warnings:
>
> usercopy_64.c:29: warning: Function parameter or member 'addr' not described in 'clean_cache_range'
> usercopy_64.c:29: warning: Excess function parameter 'vaddr' description in 'clean_cache_range'
>
> 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]
> ---
> arch/x86/lib/usercopy_64.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>

Reviewed-by: Sohil Mehta <[email protected]>