Re: [PATCH 3/3] dmaengine: xilinx: dpdma: fix kernel doc format

[Vinod Koul <vkoul@kernel.org>]

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

-- 
~Vinod