[PATCH] kmsan: headers: cleanup function and parameter names

Randy Dunlap posted 1 patch 5 days, 21 hours ago
include/linux/kmsan-checks.h |    2 +-
include/linux/kmsan.h        |    4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
[PATCH] kmsan: headers: cleanup function and parameter names
Posted by Randy Dunlap 5 days, 21 hours ago
Use the correct function names and function parameter name in the
kernel-doc comments to avoid kernel-doc warnings:

Warning: include/linux/kmsan.h:146 expecting prototype for
 kmsan_map_kernel_range_noflush(). Prototype was for
 kmsan_vmap_pages_range_noflush() instead
Warning: include/linux/kmsan.h:156 expecting prototype for
 kmsan_vunmap_kernel_range_noflush(). Prototype was for
 kmsan_vunmap_range_noflush() instead

Warning: include/linux/kmsan-checks.h:72 function parameter 'to_copy' not
 described in 'kmsan_memmove'
Warning: include/linux/kmsan-checks.h:72 Excess function parameter
 'size' description in 'kmsan_memmove'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Alexander Potapenko <glider@google.com>
Cc: Marco Elver <elver@google.com>
Cc: Dmitry Vyukov <dvyukov@google.com>
Cc: kasan-dev@googlegroups.com

 include/linux/kmsan-checks.h |    2 +-
 include/linux/kmsan.h        |    4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

--- linux-next-20260717.orig/include/linux/kmsan-checks.h
+++ linux-next-20260717/include/linux/kmsan-checks.h
@@ -65,7 +65,7 @@ void kmsan_copy_to_user(void __user *to,
  * kmsan_memmove() - Notify KMSAN about a data copy within kernel.
  * @to:   destination address in the kernel.
  * @from: source address in the kernel.
- * @size: number of bytes to copy.
+ * @to_copy: number of bytes to copy.
  *
  * Invoked after non-instrumented version (e.g. implemented using assembly
  * code) of memmove()/memcpy() is called, in order to copy KMSAN's metadata.
--- linux-next-20260717.orig/include/linux/kmsan.h
+++ linux-next-20260717/include/linux/kmsan.h
@@ -127,7 +127,7 @@ void kmsan_kmalloc_large(const void *ptr
 void kmsan_kfree_large(const void *ptr);
 
 /**
- * kmsan_map_kernel_range_noflush() - Notify KMSAN about a vmap.
+ * kmsan_vmap_pages_range_noflush() - Notify KMSAN about a vmap.
  * @start:	start of vmapped range.
  * @end:	end of vmapped range.
  * @prot:	page protection flags used for vmap.
@@ -147,7 +147,7 @@ int __must_check kmsan_vmap_pages_range_
 						gfp_t gfp_mask);
 
 /**
- * kmsan_vunmap_kernel_range_noflush() - Notify KMSAN about a vunmap.
+ * kmsan_vunmap_range_noflush() - Notify KMSAN about a vunmap.
  * @start: start of vunmapped range.
  * @end:   end of vunmapped range.
  *
Re: [PATCH] kmsan: headers: cleanup function and parameter names
Posted by Alexander Potapenko 4 days, 20 hours ago
On Sun, Jul 19, 2026 at 7:21 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Use the correct function names and function parameter name in the
> kernel-doc comments to avoid kernel-doc warnings:
>
> Warning: include/linux/kmsan.h:146 expecting prototype for
>  kmsan_map_kernel_range_noflush(). Prototype was for
>  kmsan_vmap_pages_range_noflush() instead
> Warning: include/linux/kmsan.h:156 expecting prototype for
>  kmsan_vunmap_kernel_range_noflush(). Prototype was for
>  kmsan_vunmap_range_noflush() instead
>
> Warning: include/linux/kmsan-checks.h:72 function parameter 'to_copy' not
>  described in 'kmsan_memmove'
> Warning: include/linux/kmsan-checks.h:72 Excess function parameter
>  'size' description in 'kmsan_memmove'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Alexander Potapenko <glider@google.com>
> Cc: Marco Elver <elver@google.com>
> Cc: Dmitry Vyukov <dvyukov@google.com>
> Cc: kasan-dev@googlegroups.com
Reviewed-by: Alexander Potapenko <glider@google.com>