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

[Borislav Petkov]

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 <rdunlap@xxxxxxxxxxxxx>
> Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
> Cc: Ingo Molnar <mingo@xxxxxxxxxx>
> Cc: Borislav Petkov <bp@xxxxxxxxx>
> Cc: Dave Hansen <dave.hansen@xxxxxxxxxxxxxxx>
> Cc: x86@xxxxxxxxxx
> Reviewed-by: Sohil Mehta <sohil.mehta@xxxxxxxxx>
> ---
> v2: add Rev-by: Sohil Mehta
> 
> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> 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 <rdunlap@xxxxxxxxxxxxx>
> Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
> Cc: Ingo Molnar <mingo@xxxxxxxxxx>
> Cc: Borislav Petkov <bp@xxxxxxxxx>
> Cc: Dave Hansen <dave.hansen@xxxxxxxxxxxxxxx>
> Cc: x86@xxxxxxxxxx
> Reviewed-by: Sohil Mehta <sohil.mehta@xxxxxxxxx>
> ---
> 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