netdev - Re: [PATCH net-next 1/2] scripts: kernel-doc: parse DEFINE_DMA_UNMAP

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: <093c2cf1-812e-94f7-165b-c075752dc732@intel.com>
Date: Mon, 14 Aug 2023 10:18:15 -0700
From: "Linga, Pavan Kumar" <pavan.kumar.linga@...el.com>
To: Randy Dunlap <rdunlap@...radead.org>, <netdev@...r.kernel.org>,
	<kuba@...nel.org>
CC: <linux-doc@...r.kernel.org>, <corbet@....net>,
	<emil.s.tantilov@...el.com>, <joshua.a.hay@...el.com>,
	<sridhar.samudrala@...el.com>, <alan.brady@...el.com>,
	<madhu.chittim@...el.com>, <jesse.brandeburg@...el.com>,
	<anthony.l.nguyen@...el.com>, <willemb@...gle.com>, <decot@...gle.com>
Subject: Re: [PATCH net-next 1/2] scripts: kernel-doc: parse
 DEFINE_DMA_UNMAP_[ADDR|LEN]



On 8/11/2023 9:47 PM, Randy Dunlap wrote:
> 
> 
> On 8/11/23 17:25, Pavan Kumar Linga wrote:
>> At present, if the marcos DEFINE_DMA_UNMAP_ADDR() and
> 
>                       macros
> 
>> DEFINE_DMA_UNMAP_LEN() are used in the structures as shown
>> below, instead of parsing the parameter in the parenthesis,
> 
>                                                   parentheses
> 
>> kernel-doc parses 'DEFINE_DMA_UNMAP_ADDR(' and
>> 'DEFINE_DMA_UNMAP_LEN(' which results in the following
>> warnings:
>>
>> drivers/net/ethernet/intel/idpf/idpf_txrx.h:201: warning: Function
>> parameter or member 'DEFINE_DMA_UNMAP_ADDR(dma' not described in
>> 'idpf_tx_buf'
>> drivers/net/ethernet/intel/idpf/idpf_txrx.h:201: warning: Function
>> parameter or member 'DEFINE_DMA_UNMAP_LEN(len' not described in
>> 'idpf_tx_buf'
>>
>> struct idpf_tx_buf {
>> 	DEFINE_DMA_UNMAP_ADDR(dma);
>> 	DEFINE_DMA_UNMAP_LEN(len);
>> };
>>
>> Fix the warnings by parsing DEFINE_DMA_UNMAP_ADDR() and
>> DEFINE_DMA_UNMAP_LEN().
>>
>> Signed-off-by: Pavan Kumar Linga <pavan.kumar.linga@...el.com>
> 
> Looks good. Thanks.
> Acked-by: Randy Dunlap <rdunlap@...radead.org>
> 

Thanks for the review. Fixed the typos in the v2 revision.

>> ---
>>   scripts/kernel-doc | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
>> index d0116c6939dc..cfb1cb223508 100755
>> --- a/scripts/kernel-doc
>> +++ b/scripts/kernel-doc
>> @@ -1168,6 +1168,10 @@ sub dump_struct($$) {
>>   	$members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
>>   	# replace DECLARE_FLEX_ARRAY
>>   	$members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos;
>> +	#replace DEFINE_DMA_UNMAP_ADDR
>> +	$members =~ s/DEFINE_DMA_UNMAP_ADDR\s*\($args\)/dma_addr_t $1/gos;
>> +	#replace DEFINE_DMA_UNMAP_LEN
>> +	$members =~ s/DEFINE_DMA_UNMAP_LEN\s*\($args\)/__u32 $1/gos;
>>   	my $declaration = $members;
>>   
>>   	# Split nested struct/union elements as newer ones
> 

Regards,
Pavan