| Message ID | 20230814170720.46229-2-pavan.kumar.linga@intel.com (mailing list archive) |
|---|---|
| State | Not Applicable |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | Fix invalid kernel-doc warnings | expand |
| Context | Check | Description |
|---|---|---|
| netdev/series_format | success | Posting correctly formatted |
| netdev/tree_selection | success | Clearly marked for net-next |
| netdev/fixes_present | success | Fixes tag not required for -next series |
| netdev/header_inline | success | No static functions without inline keyword in header files |
| netdev/build_32bit | success | Errors and warnings before: 9 this patch: 9 |
| netdev/cc_maintainers | success | CCed 2 of 2 maintainers |
| netdev/build_clang | success | Errors and warnings before: 9 this patch: 9 |
| netdev/verify_signedoff | success | Signed-off-by tag matches author and committer |
| netdev/deprecated_api | success | None detected |
| netdev/check_selftest | success | No net selftest shell script |
| netdev/verify_fixes | success | No Fixes tag |
| netdev/build_allmodconfig_warn | success | Errors and warnings before: 9 this patch: 9 |
| netdev/checkpatch | success | total: 0 errors, 0 warnings, 0 checks, 10 lines checked |
| netdev/kdoc | success | Errors and warnings before: 0 this patch: 0 |
| netdev/source_inline | success | Was 0 now: 0 |
Pavan Kumar Linga <pavan.kumar.linga@intel.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@intel.com> > Acked-by: Randy Dunlap <rdunlap@infradead.org> > --- > scripts/kernel-doc | 4 ++++ > 1 file changed, 4 insertions(+) Is there a reason why you didn't CC me on these? > 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, jon
On 8/14/2023 11:57 AM, Jonathan Corbet wrote: > Pavan Kumar Linga <pavan.kumar.linga@intel.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@intel.com> >> Acked-by: Randy Dunlap <rdunlap@infradead.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
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
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@intel.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> --- scripts/kernel-doc | 4 ++++ 1 file changed, 4 insertions(+)