| Message ID | 20200718135201.191881-3-vkoul@kernel.org (mailing list archive) |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | [1/3] dmaengine: xilinx: dpdma: remove comparison of unsigned expression | expand |
Hi Vinod, Thank you for the patch. On Sat, Jul 18, 2020 at 07:22:01PM +0530, Vinod Koul wrote: > xilinx_dpdma_chan structure documents 'desc' members, but that leads > to warnings, so split that up and describe members > > drivers/dma/xilinx/xilinx_dpdma.c:241: warning: Function parameter or > member 'desc' not described in 'xilinx_dpdma_chan' > > Signed-off-by: Vinod Koul <vkoul@kernel.org> > --- > drivers/dma/xilinx/xilinx_dpdma.c | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/drivers/dma/xilinx/xilinx_dpdma.c b/drivers/dma/xilinx/xilinx_dpdma.c > index 430f3714f6a3..d94c75a842f8 100644 > --- a/drivers/dma/xilinx/xilinx_dpdma.c > +++ b/drivers/dma/xilinx/xilinx_dpdma.c > @@ -214,8 +214,8 @@ struct xilinx_dpdma_tx_desc { > * @lock: lock to access struct xilinx_dpdma_chan > * @desc_pool: descriptor allocation pool > * @err_task: error IRQ bottom half handler > - * @desc.pending: Descriptor schedule to the hardware, pending execution > - * @desc.active: Descriptor being executed by the hardware > + * @desc: pending: Descriptor schedule to the hardware, pending execution > + * active: Descriptor being executed by the hardware According to https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#nested-structs-unions, the existing syntax is supposed to be valid. Where does the above warning come from ? > * @xdev: DPDMA device > */ > struct xilinx_dpdma_chan {
On 22-07-20, 16:11, Laurent Pinchart wrote: > Hi Vinod, > > Thank you for the patch. > > On Sat, Jul 18, 2020 at 07:22:01PM +0530, Vinod Koul wrote: > > xilinx_dpdma_chan structure documents 'desc' members, but that leads > > to warnings, so split that up and describe members > > > > drivers/dma/xilinx/xilinx_dpdma.c:241: warning: Function parameter or > > member 'desc' not described in 'xilinx_dpdma_chan' > > > > Signed-off-by: Vinod Koul <vkoul@kernel.org> > > --- > > drivers/dma/xilinx/xilinx_dpdma.c | 4 ++-- > > 1 file changed, 2 insertions(+), 2 deletions(-) > > > > diff --git a/drivers/dma/xilinx/xilinx_dpdma.c b/drivers/dma/xilinx/xilinx_dpdma.c > > index 430f3714f6a3..d94c75a842f8 100644 > > --- a/drivers/dma/xilinx/xilinx_dpdma.c > > +++ b/drivers/dma/xilinx/xilinx_dpdma.c > > @@ -214,8 +214,8 @@ struct xilinx_dpdma_tx_desc { > > * @lock: lock to access struct xilinx_dpdma_chan > > * @desc_pool: descriptor allocation pool > > * @err_task: error IRQ bottom half handler > > - * @desc.pending: Descriptor schedule to the hardware, pending execution > > - * @desc.active: Descriptor being executed by the hardware > > + * @desc: pending: Descriptor schedule to the hardware, pending execution > > + * active: Descriptor being executed by the hardware > > According to > https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#nested-structs-unions, > the existing syntax is supposed to be valid. Where does the above > warning come from ? W=1 build again.. > > > * @xdev: DPDMA device > > */ > > struct xilinx_dpdma_chan { > > -- > Regards, > > Laurent Pinchart
Hi Vinod, On Wed, Jul 22, 2020 at 07:56:08PM +0530, Vinod Koul wrote: > On 22-07-20, 16:11, Laurent Pinchart wrote: > > On Sat, Jul 18, 2020 at 07:22:01PM +0530, Vinod Koul wrote: > > > xilinx_dpdma_chan structure documents 'desc' members, but that leads > > > to warnings, so split that up and describe members > > > > > > drivers/dma/xilinx/xilinx_dpdma.c:241: warning: Function parameter or > > > member 'desc' not described in 'xilinx_dpdma_chan' > > > > > > Signed-off-by: Vinod Koul <vkoul@kernel.org> > > > --- > > > drivers/dma/xilinx/xilinx_dpdma.c | 4 ++-- > > > 1 file changed, 2 insertions(+), 2 deletions(-) > > > > > > diff --git a/drivers/dma/xilinx/xilinx_dpdma.c b/drivers/dma/xilinx/xilinx_dpdma.c > > > index 430f3714f6a3..d94c75a842f8 100644 > > > --- a/drivers/dma/xilinx/xilinx_dpdma.c > > > +++ b/drivers/dma/xilinx/xilinx_dpdma.c > > > @@ -214,8 +214,8 @@ struct xilinx_dpdma_tx_desc { > > > * @lock: lock to access struct xilinx_dpdma_chan > > > * @desc_pool: descriptor allocation pool > > > * @err_task: error IRQ bottom half handler > > > - * @desc.pending: Descriptor schedule to the hardware, pending execution > > > - * @desc.active: Descriptor being executed by the hardware > > > + * @desc: pending: Descriptor schedule to the hardware, pending execution > > > + * active: Descriptor being executed by the hardware > > > > According to > > https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#nested-structs-unions, > > the existing syntax is supposed to be valid. Where does the above > > warning come from ? > > W=1 build again.. I get the same when plumbing the source file into the kerneldoc build. The generated documentation however contains the description of both desc.pending and desc.active. If you want to fix the warning, I think you should instead add a line to document @desc, but without removing the existing @desc.pending and @desc.active lines. > > > * @xdev: DPDMA device > > > */ > > > struct xilinx_dpdma_chan {
On 22-07-20, 17:51, Laurent Pinchart wrote: > > W=1 build again.. > > I get the same when plumbing the source file into the kerneldoc build. > The generated documentation however contains the description of both > desc.pending and desc.active. If you want to fix the warning, I think > you should instead add a line to document @desc, but without removing > the existing @desc.pending and @desc.active lines. I would like to see clean build with W=1, helps to find other issues :) So do feel free to send the patch to fix this, i will swap them..
On Wed, Jul 22, 2020 at 08:24:35PM +0530, Vinod Koul wrote: > On 22-07-20, 17:51, Laurent Pinchart wrote: > > > > W=1 build again.. > > > > I get the same when plumbing the source file into the kerneldoc build. > > The generated documentation however contains the description of both > > desc.pending and desc.active. If you want to fix the warning, I think > > you should instead add a line to document @desc, but without removing > > the existing @desc.pending and @desc.active lines. > > I would like to see clean build with W=1, helps to find other issues :) > So do feel free to send the patch to fix this, i will swap them.. Done, see "[PATCH] dmaengine: xilinx: dpdma: Fix kerneldoc warning".
diff --git a/drivers/dma/xilinx/xilinx_dpdma.c b/drivers/dma/xilinx/xilinx_dpdma.c index 430f3714f6a3..d94c75a842f8 100644 --- a/drivers/dma/xilinx/xilinx_dpdma.c +++ b/drivers/dma/xilinx/xilinx_dpdma.c @@ -214,8 +214,8 @@ struct xilinx_dpdma_tx_desc { * @lock: lock to access struct xilinx_dpdma_chan * @desc_pool: descriptor allocation pool * @err_task: error IRQ bottom half handler - * @desc.pending: Descriptor schedule to the hardware, pending execution - * @desc.active: Descriptor being executed by the hardware + * @desc: pending: Descriptor schedule to the hardware, pending execution + * active: Descriptor being executed by the hardware * @xdev: DPDMA device */ struct xilinx_dpdma_chan {
xilinx_dpdma_chan structure documents 'desc' members, but that leads to warnings, so split that up and describe members drivers/dma/xilinx/xilinx_dpdma.c:241: warning: Function parameter or member 'desc' not described in 'xilinx_dpdma_chan' Signed-off-by: Vinod Koul <vkoul@kernel.org> --- drivers/dma/xilinx/xilinx_dpdma.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)