]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
net/iucv: clean up iucv kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Tue, 3 Feb 2026 07:52:48 +0000 (23:52 -0800)
committerJakub Kicinski <kuba@kernel.org>
Thu, 5 Feb 2026 04:39:58 +0000 (20:39 -0800)
commita34b0e4e21d6be3c3d620aa7f9dfbf0e9550c19e
tree261091637a5d67c3ea1e5c0c251726df4e6989c1
parent42a940ef18455eafa2de7cf5fffe7abeba43e250
net/iucv: clean up iucv kernel-doc warnings

Fix numerous (many) kernel-doc warnings in iucv.[ch]:

- convert function documentation comments to a common (kernel-doc) look,
  even for static functions (without "/**")
- use matching parameter and parameter description names
- use better wording in function descriptions (Jakub & AI)
- remove duplicate kernel-doc comments from the header file (Jakub)

Examples:

Warning: include/net/iucv/iucv.h:210 missing initial short description
 on line: * iucv_unregister
Warning: include/net/iucv/iucv.h:216 function parameter 'handle' not
 described in 'iucv_unregister'
Warning: include/net/iucv/iucv.h:467 function parameter 'answer' not
 described in 'iucv_message_send2way'
Warning: net/iucv/iucv.c:727 missing initial short description on line:
 * iucv_cleanup_queue

Build-tested with both "make htmldocs" and "make ARCH=s390 defconfig all".

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Alexandra Winter <wintera@linux.ibm.com>
Link: https://patch.msgid.link/20260203075248.1177869-1-rdunlap@infradead.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
include/net/iucv/iucv.h
net/iucv/iucv.c