netdev - Re: [PATCH 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] [thread-next>] [day] [month] [year] [list]

Message-ID: <16c2528a-85be-4f7b-a60a-923613ecc8fb@infradead.org>
Date: Sat, 31 Jan 2026 16:01:04 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Jakub Kicinski <kuba@...nel.org>
Cc: netdev@...r.kernel.org, Alexandra Winter <wintera@...ux.ibm.com>,
 Thorsten Winkler <twinkler@...ux.ibm.com>, linux-s390@...r.kernel.org,
 "David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>,
 Paolo Abeni <pabeni@...hat.com>, Simon Horman <horms@...nel.org>
Subject: Re: [PATCH net-next] net/iucv: clean up iucv kernel-doc warnings



On 1/31/26 1:11 PM, Jakub Kicinski wrote:
> On Thu, 29 Jan 2026 21:47:59 -0800 Randy Dunlap wrote:
>>  /**
>> - * __iucv_message_receive
>> + * __iucv_message_receive - Terminates an IUCV path.
> 
> AI code review complains this is odd wording since the main body
> describes reception not termination.
> 
>>   * @path: address of iucv path structure
>>   * @msg: address of iucv msg structure
>>   * @flags: flags that affect how the message is received (IUCV_IPBUFLST)
>> @@ -374,7 +363,7 @@ int __iucv_message_receive(struct iucv_p
>>  			   size_t *residual);
>>  
>>  /**
>> - * iucv_message_reject
>> + * iucv_message_reject - Refuses a specified message
>>   * @path: address of iucv path structure
>>   * @msg: address of iucv msg structure
>>   *
>> @@ -387,7 +376,7 @@ int __iucv_message_receive(struct iucv_p
>>  int iucv_message_reject(struct iucv_path *path, struct iucv_message *msg);
>>  
>>  /**
>> - * iucv_message_reply
>> + * iucv_message_reply - Refuses a specified message
> 
> Same here, refuses or replies?
> 
>>   * @path: address of iucv path structure
>>   * @msg: address of iucv msg structure
>>   * @flags: how the reply is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST)
> 
> In general -- Could we possibly delete the duplicated kdocs in 
> the header. As clearly shown by this patch it's double the work
> and kernel-doc will be able to find the definition wherever it is.
> Kernel coding guide recommends kdoc next to definition.

Thanks. I'll check all of that.

-- 
~Randy