x86/lib: checksum_64.h: Eliminate all kernel-doc warnings

Browse source

- correct missing function parameter names
 - add missing function return value sections
 - use the correct function name in comments

to avoid these warnings (samples):

  Warning: arch/x86/include/asm/checksum_64.h:23 No description found for return value of 'csum_fold'
  Warning: arch/x86/include/asm/checksum_64.h:46 function parameter 'iph' not described in 'ip_fast_csum'
  Warning: arch/x86/include/asm/checksum_64.h:46 function parameter 'ihl' not described in 'ip_fast_csum'
  Warning: arch/x86/include/asm/checksum_64.h:46 No description found for return value of 'ip_fast_csum'
  Warning: arch/x86/include/asm/checksum_64.h:89 expecting prototype for csum_tcpup_nofold(). Prototype was for csum_tcpudp_nofold() instead
  Warning: arch/x86/include/asm/checksum_64.h:115 expecting prototype for csum_tcpup_magic(). Prototype was for csum_tcpudp_magic() instead
  Warning: arch/x86/include/asm/checksum_64.h:119 No description found for return value of 'csum_tcpudp_magic'
  Warning: arch/x86/include/asm/checksum_64.h:129 No description found for return value of 'csum_partial'
  Warning: ./arch/x86/include/asm/checksum_64.h:175 function parameter '_saddr' not described in 'csum_ipv6_magic'
  Warning: ./arch/x86/include/asm/checksum_64.h:175 function parameter '_daddr' not described in 'csum_ipv6_magic'
  Warning: ./arch/x86/include/asm/checksum_64.h:175 Excess function parameter 'saddr' description in 'csum_ipv6_magic'
  Warning: ./arch/x86/include/asm/checksum_64.h:175 Excess function parameter 'daddr' description in 'csum_ipv6_magic'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Link: https://patch.msgid.link/20260730233429.285788-4-rdunlap@infradead.org

...

This commit is contained in:

Randy Dunlap 2026-07-30 16:34:27 -07:00 • committed by Ingo Molnar

parent 6b191a1c5d

commit 7bb518c386

1 changed files with 17 additions and 12 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

29

arch/x86/include/asm/checksum_64.h

View file