2024-02-11 06:25:13

by Randy Dunlap

Subject: [PATCH v2] 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]
Reviewed-by: Sohil Mehta <[email protected]>
---
v2: add Rev-by: Sohil Mehta

From: Randy Dunlap <[email protected]>
Subject: [PATCH v2] 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]
Reviewed-by: Sohil Mehta <[email protected]>
---
v2: add Rev-by: Sohil Mehta

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)
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)

2024-02-13 21:47:31

by Borislav Petkov

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

On Sat, Feb 10, 2024 at 10:25:01PM -0800, 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]
> Reviewed-by: Sohil Mehta <[email protected]>
> ---
> v2: add Rev-by: Sohil Mehta
>
> From: Randy Dunlap <[email protected]>
> Subject: [PATCH v2] 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]
> Reviewed-by: Sohil Mehta <[email protected]>
> ---
> v2: add Rev-by: Sohil Mehta
>
> 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)
> 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)

What happened here? :)

Commit message and patch diff appear twice.

Once not enough huh?

:-P

--
Regards/Gruss,
Boris.

https://people.kernel.org/tglx/notes-about-netiquette

2024-02-14 01:33:10

by Randy Dunlap

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

On 2/13/24 13:43, Borislav Petkov wrote:
> On Sat, Feb 10, 2024 at 10:25:01PM -0800, Randy Dunlap wrote:
>> Correct the function parameter name in clean_cache_range() to prevent
>> kernel-doc warnings:

>
> What happened here? :)
>
> Commit message and patch diff appear twice.
>
> Once not enough huh?
>
> :-P
>

Wow, I have no idea. I'll fix it up.

Thanks.

--
#Randy