| Message ID | 20230812002549.36286-2-pavan.kumar.linga@intel.com (mailing list archive) |
|---|---|
| State | Superseded |
| 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 |
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@intel.com> Looks good. Thanks. Acked-by: Randy Dunlap <rdunlap@infradead.org> > --- > 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
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@intel.com> > > Looks good. Thanks. > Acked-by: Randy Dunlap <rdunlap@infradead.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
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 marcos DEFINE_DMA_UNMAP_ADDR() and DEFINE_DMA_UNMAP_LEN() are used in the structures as shown below, instead of parsing the parameter in the parenthesis, 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> --- scripts/kernel-doc | 4 ++++ 1 file changed, 4 insertions(+)