[PATCH] uaccess: correct kernel-doc parameter format

Randy Dunlap posted 1 patch 1 month, 2 weeks ago
include/linux/uaccess.h |    4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
[PATCH] uaccess: correct kernel-doc parameter format
Posted by Randy Dunlap 1 month, 2 weeks ago
Use the correct kernel-doc function parameter format to avoid
kernel-doc warnings:

Warning: include/linux/uaccess.h:814 function parameter 'uptr' not
 described in 'scoped_user_rw_access_size'
Warning: include/linux/uaccess.h:826 function parameter 'uptr' not
 described in 'scoped_user_rw_access'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Andrew Morton <akpm@linux-foundation.org>

 include/linux/uaccess.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20260227.orig/include/linux/uaccess.h
+++ linux-next-20260227/include/linux/uaccess.h
@@ -806,7 +806,7 @@ for (bool done = false; !done; done = tr
 
 /**
  * scoped_user_rw_access_size - Start a scoped user read/write access with given size
- * @uptr	Pointer to the user space address to read from and write to
+ * @uptr:	Pointer to the user space address to read from and write to
  * @size:	Size of the access starting from @uptr
  * @elbl:	Error label to goto when the access region is rejected
  *
@@ -817,7 +817,7 @@ for (bool done = false; !done; done = tr
 
 /**
  * scoped_user_rw_access - Start a scoped user read/write access
- * @uptr	Pointer to the user space address to read from and write to
+ * @uptr:	Pointer to the user space address to read from and write to
  * @elbl:	Error label to goto when the access region is rejected
  *
  * The size of the access starting from @uptr is determined via sizeof(*@uptr)).
Re: [PATCH] uaccess: correct kernel-doc parameter format
Posted by SeongJae Park 1 month, 2 weeks ago
On Sun,  1 Mar 2026 16:52:29 -0800 Randy Dunlap <rdunlap@infradead.org> wrote:

> Use the correct kernel-doc function parameter format to avoid
> kernel-doc warnings:
> 
> Warning: include/linux/uaccess.h:814 function parameter 'uptr' not
>  described in 'scoped_user_rw_access_size'
> Warning: include/linux/uaccess.h:826 function parameter 'uptr' not
>  described in 'scoped_user_rw_access'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: SeongJae Park <sj@kernel.org>


Thanks,
SJ

[...]