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

Message-ID: <5b6d4e1c-aaa1-b73e-0360-3cf6893bbaf8@intel.com>
Date: Mon, 14 Aug 2023 14:13:24 -0700
From: "Linga, Pavan Kumar" <pavan.kumar.linga@...el.com>
To: Jonathan Corbet <corbet@....net>, <netdev@...r.kernel.org>,
	<kuba@...nel.org>
CC: <linux-doc@...r.kernel.org>, <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>, <rdunlap@...radead.org>
Subject: Re: [PATCH net-next v2 1/2] scripts: kernel-doc: parse
 DEFINE_DMA_UNMAP_[ADDR|LEN]



On 8/14/2023 11:57 AM, Jonathan Corbet wrote:
> Pavan Kumar Linga <pavan.kumar.linga@...el.com> writes:
> 
>> At present, if the macros DEFINE_DMA_UNMAP_ADDR() and
>> DEFINE_DMA_UNMAP_LEN() are used in the structures as shown
>> below, instead of parsing the parameter in the 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>
>> Acked-by: Randy Dunlap <rdunlap@...radead.org>
>> ---
>>   scripts/kernel-doc | 4 ++++
>>   1 file changed, 4 insertions(+)
> 
> Is there a reason why you didn't CC me on these?
> 

It was unintentional and my apologies, as I thought CC'ing you while 
sending the patches should be good. If the ask is to add the 'Cc:' tag 
to the patch, will do that in the next revision.

>> 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;
> 
> I'm not happy with this ... we are continuing to reimplement parts of
> the C preprocessor here, badly, creating an ugly mess in the process.
> 
> That said, you are just the latest arrival at the party, can't blame you
> for this.  Until we come up with a better way here, I guess this will
> do.
> 

Thanks for providing your feedback.

> Thanks,
> 
> jon

Regards,
Pavan