netdev - Re: [PATCH v3 net-next] net/iucv: clean up iucv kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <2dfeee9a-ea5e-4f8d-822e-d7ee84544c5e@infradead.org>
Date: Tue, 3 Feb 2026 10:30:51 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Alexandra Winter <wintera@...ux.ibm.com>, netdev@...r.kernel.org
Cc: Thorsten Winkler <twinkler@...ux.ibm.com>, linux-s390@...r.kernel.org,
 "David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>,
 Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
 Simon Horman <horms@...nel.org>
Subject: Re: [PATCH v3 net-next] net/iucv: clean up iucv kernel-doc warnings



On 2/3/26 1:39 AM, Alexandra Winter wrote:
> 
> 
> On 03.02.26 08:52, Randy Dunlap wrote:
>> 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@...radead.org>
>> ---
>> v3:
>> - I didn't use Alexandra'a (v2) Reviewed-by: due to the number of changes.
>> - leave kernel-doc ("/**") on static functions in iucv.c (I did not
>>   convert other static functions to kernel-doc comments.)
> 
> Thank you. Feel free to add
> Reviewed-by: Alexandra Winter <wintera@...ux.ibm.com>
> 
> 
> There are still warnings left about missing return value descriptions:
>> make W=2 clean net/iucv/ 2>&1 | grep ^Warning
> Warning: net/iucv/iucv.c:691 No description found for return value of 'iucv_sever_pathid'
> Warning: net/iucv/iucv.c:1099 No description found for return value of 'iucv_message_receive_iprmdata'
> Warning: net/iucv/iucv.c:1856 No description found for return value of 'iucv_init'
> Warning: net/iucv/iucv.c:691 No description found for return value of 'iucv_sever_pathid'
> Warning: net/iucv/iucv.c:1099 No description found for return value of 'iucv_message_receive_iprmdata'
> Warning: net/iucv/iucv.c:1856 No description found for return value of 'iucv_init'
> Warning: net/iucv/af_iucv.c:131 No description found for return value of 'iucv_msg_length'
> Warning: net/iucv/af_iucv.c:150 No description found for return value of 'iucv_sock_in_state'
> Warning: net/iucv/af_iucv.c:163 No description found for return value of 'iucv_below_msglim'
> Warning: net/iucv/af_iucv.c:889 No description found for return value of 'iucv_send_iprm'
> Warning: net/iucv/af_iucv.c:131 No description found for return value of 'iucv_msg_length'
> Warning: net/iucv/af_iucv.c:150 No description found for return value of 'iucv_sock_in_state'
> Warning: net/iucv/af_iucv.c:163 No description found for return value of 'iucv_below_msglim'
> Warning: net/iucv/af_iucv.c:889 No description found for return value of 'iucv_send_iprm'
> 
> Our team will fix those, unless you want to add them to this patch.

Please go ahead with those fixes.
Thanks.

-- 
~Randy