[tip: x86/cleanups] x86/usercopy: Fix kernel-doc func param name in clean_cache_range()'s description

From: tip-bot2 for Randy Dunlap
Date: Sun Feb 23 2025 - 10:40:06 EST


The following commit has been merged into the x86/cleanups branch of tip:

Commit-ID: 51184c3c96a19b5143710ef91426e311f4364bac
Gitweb: https://git.kernel.org/tip/51184c3c96a19b5143710ef91426e311f4364bac
Author: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
AuthorDate: Fri, 10 Jan 2025 22:33:33 -08:00
Committer: Borislav Petkov (AMD) <bp@xxxxxxxxx>
CommitterDate: Sun, 23 Feb 2025 11:52:48 +01:00

x86/usercopy: Fix kernel-doc func param name in clean_cache_range()'s description

Use @addr instead of @vaddr in the kernel-doc comment for
clean_cache_range() to eliminate warnings:

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

Fixes: 0aed55af8834 ("x86, uaccess: introduce copy_from_iter_flushcache for pmem / cache-bypass operations")
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Signed-off-by: Borislav Petkov (AMD) <bp@xxxxxxxxx>
Link: https://lore.kernel.org/r/20250111063333.911084-1-rdunlap@xxxxxxxxxxxxx
---
arch/x86/lib/usercopy_64.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/lib/usercopy_64.c b/arch/x86/lib/usercopy_64.c
index e9251b8..654280a 100644
--- 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)