[PATCH] Correct documentation comments for x86 csum_and_copy_...user()

[PATCH] Correct documentation comments for x86 csum_and_copy_...user()

[William Kucharski]

Clean up of calling conventions for csum_and_copy_..._user() did not update
associated documentation comments to account for the removal of additional
parameters.

Fixes: c693cc4676a0 ("saner calling conventions for csum_and_copy_..._user()")
Signed-off-by: William Kucharski <william.kucharski@oracle.com>
---
 arch/x86/lib/csum-wrappers_64.c | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/arch/x86/lib/csum-wrappers_64.c b/arch/x86/lib/csum-wrappers_64.c
index 189344924a2b..25d533502693 100644
--- a/arch/x86/lib/csum-wrappers_64.c
+++ b/arch/x86/lib/csum-wrappers_64.c
@@ -14,8 +14,6 @@
  * @src: source address (user space)
  * @dst: destination address
  * @len: number of bytes to be copied.
- * @isum: initial sum that is added into the result (32bit unfolded)
- * @errp: set to -EFAULT for an bad source address.
  *
  * Returns an 32bit unfolded checksum of the buffer.
  * src and dst are best aligned to 64bits.
@@ -39,8 +37,6 @@ EXPORT_SYMBOL(csum_and_copy_from_user);
  * @src: source address
  * @dst: destination address (user space)
  * @len: number of bytes to be copied.
- * @isum: initial sum that is added into the result (32bit unfolded)
- * @errp: set to -EFAULT for an bad destination address.
  *
  * Returns an 32bit unfolded checksum of the buffer.
  * src and dst are best aligned to 64bits.
@@ -64,7 +60,6 @@ EXPORT_SYMBOL(csum_and_copy_to_user);
  * @src: source address
  * @dst: destination address
  * @len: number of bytes to be copied.
- * @sum: initial sum that is added into the result (32bit unfolded)
  *
  * Returns an 32bit unfolded checksum of the buffer.
  */
-- 
2.34.1

Re: [PATCH] Correct documentation comments for x86 csum_and_copy_...user()

[Matthew Wilcox]

On Sat, Feb 05, 2022 at 05:14:56AM -0700, William Kucharski wrote:
> Clean up of calling conventions for csum_and_copy_..._user() did not update
> associated documentation comments to account for the removal of additional
> parameters.
> 
> Fixes: c693cc4676a0 ("saner calling conventions for csum_and_copy_..._user()")
> Signed-off-by: William Kucharski <william.kucharski@oracle.com>

Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org>

Re: [PATCH] Correct documentation comments for x86 csum_and_copy_...user()

[Borislav Petkov]

On Sat, Feb 05, 2022 at 05:14:56AM -0700, William Kucharski wrote:
> Clean up of calling conventions for csum_and_copy_..._user() did not update
> associated documentation comments to account for the removal of additional
> parameters.
> 
> Fixes: c693cc4676a0 ("saner calling conventions for csum_and_copy_..._user()")
> Signed-off-by: William Kucharski <william.kucharski@oracle.com>
> ---
>  arch/x86/lib/csum-wrappers_64.c | 5 -----
>  1 file changed, 5 deletions(-)
> 
> diff --git a/arch/x86/lib/csum-wrappers_64.c b/arch/x86/lib/csum-wrappers_64.c
> index 189344924a2b..25d533502693 100644
> --- a/arch/x86/lib/csum-wrappers_64.c
> +++ b/arch/x86/lib/csum-wrappers_64.c
> @@ -14,8 +14,6 @@
>   * @src: source address (user space)
>   * @dst: destination address
>   * @len: number of bytes to be copied.
> - * @isum: initial sum that is added into the result (32bit unfolded)
> - * @errp: set to -EFAULT for an bad source address.
>   *
>   * Returns an 32bit unfolded checksum of the buffer.
>   * src and dst are best aligned to 64bits.
> @@ -39,8 +37,6 @@ EXPORT_SYMBOL(csum_and_copy_from_user);
>   * @src: source address
>   * @dst: destination address (user space)
>   * @len: number of bytes to be copied.
> - * @isum: initial sum that is added into the result (32bit unfolded)
> - * @errp: set to -EFAULT for an bad destination address.
>   *
>   * Returns an 32bit unfolded checksum of the buffer.
>   * src and dst are best aligned to 64bits.
> @@ -64,7 +60,6 @@ EXPORT_SYMBOL(csum_and_copy_to_user);
>   * @src: source address
>   * @dst: destination address
>   * @len: number of bytes to be copied.
> - * @sum: initial sum that is added into the result (32bit unfolded)
>   *
>   * Returns an 32bit unfolded checksum of the buffer.
>   */
> -- 

Wanna fix the rest of kernel-doc formatting issues while at it?

$ ./scripts/kernel-doc -v -none arch/x86/lib/csum-wrappers_64.c
arch/x86/lib/csum-wrappers_64.c:13: info: Scanning doc for function csum_and_copy_from_user
arch/x86/lib/csum-wrappers_64.c:23: warning: No description found for return value of 'csum_and_copy_from_user'
arch/x86/lib/csum-wrappers_64.c:36: info: Scanning doc for function csum_and_copy_to_user
arch/x86/lib/csum-wrappers_64.c:46: warning: No description found for return value of 'csum_and_copy_to_user'
arch/x86/lib/csum-wrappers_64.c:59: info: Scanning doc for function csum_partial_copy_nocheck
arch/x86/lib/csum-wrappers_64.c:68: warning: No description found for return value of 'csum_partial_copy_nocheck'

-- 
Regards/Gruss,
    Boris.

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