linux-kernel - [tip: x86/cleanups] x86/usercopy: Fix kernel-doc func param name in clean_cache

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: <174032518667.10177.8688571407789662677.tip-bot2@tip-bot2>
Date: Sun, 23 Feb 2025 15:39:46 -0000
From: "tip-bot2 for Randy Dunlap" <tip-bot2@...utronix.de>
To: linux-tip-commits@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
 "Borislav Petkov (AMD)" <bp@...en8.de>, x86@...nel.org,
 linux-kernel@...r.kernel.org
Subject: [tip: x86/cleanups] x86/usercopy: Fix kernel-doc func param name in
 clean_cache_range()'s description

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@...radead.org>
AuthorDate:    Fri, 10 Jan 2025 22:33:33 -08:00
Committer:     Borislav Petkov (AMD) <bp@...en8.de>
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@...radead.org>
Signed-off-by: Borislav Petkov (AMD) <bp@...en8.de>
Link: https://lore.kernel.org/r/20250111063333.911084-1-rdunlap@infradead.org
---
 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)