[PATCH -next] dmaengine: xilinx: xdma: Fix some kernel-doc comments

[PATCH -next] dmaengine: xilinx: xdma: Fix some kernel-doc comments

[Yang Li]

Make the description of @xdma_chan to @xchan to silence the warnings:

drivers/dma/xilinx/xdma.c:283: warning: Function parameter or member 'xchan' not described in 'xdma_xfer_start'
drivers/dma/xilinx/xdma.c:283: warning: Excess function parameter 'xdma_chan' description in 'xdma_xfer_start'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=4051
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 drivers/dma/xilinx/xdma.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/dma/xilinx/xdma.c b/drivers/dma/xilinx/xdma.c
index 462109c61653..93ee298d52b8 100644
--- a/drivers/dma/xilinx/xdma.c
+++ b/drivers/dma/xilinx/xdma.c
@@ -277,7 +277,7 @@ xdma_alloc_desc(struct xdma_chan *chan, u32 desc_num)
 
 /**
  * xdma_xfer_start - Start DMA transfer
- * @xdma_chan: DMA channel pointer
+ * @xchan: DMA channel pointer
  */
 static int xdma_xfer_start(struct xdma_chan *xchan)
 {
-- 
2.20.1.7.g153144c


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

Re: [PATCH -next] dmaengine: xilinx: xdma: Fix some kernel-doc comments

[Peter Korsgaard]

>>>>> "Yang" == Yang Li <yang.lee@linux.alibaba.com> writes:

 > Make the description of @xdma_chan to @xchan to silence the warnings:
 > drivers/dma/xilinx/xdma.c:283: warning: Function parameter or member 'xchan' not described in 'xdma_xfer_start'
 > drivers/dma/xilinx/xdma.c:283: warning: Excess function parameter 'xdma_chan' description in 'xdma_xfer_start'

 > Reported-by: Abaci Robot <abaci@linux.alibaba.com>
 > Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=4051
 > Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Acked-by: Peter Korsgaard <peter@korsgaard.com>

> ---
 >  drivers/dma/xilinx/xdma.c | 2 +-
 >  1 file changed, 1 insertion(+), 1 deletion(-)

 > diff --git a/drivers/dma/xilinx/xdma.c b/drivers/dma/xilinx/xdma.c
 > index 462109c61653..93ee298d52b8 100644
 > --- a/drivers/dma/xilinx/xdma.c
 > +++ b/drivers/dma/xilinx/xdma.c
 > @@ -277,7 +277,7 @@ xdma_alloc_desc(struct xdma_chan *chan, u32 desc_num)
 
 >  /**
 >   * xdma_xfer_start - Start DMA transfer
 > - * @xdma_chan: DMA channel pointer
 > + * @xchan: DMA channel pointer
 >   */
 >  static int xdma_xfer_start(struct xdma_chan *xchan)
 >  {
 > -- 

 > 2.20.1.7.g153144c


-- 
Bye, Peter Korsgaard

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

Re: [PATCH -next] dmaengine: xilinx: xdma: Fix some kernel-doc comments

[Vinod Koul]

On 14-02-23, 09:03, Yang Li wrote:
> Make the description of @xdma_chan to @xchan to silence the warnings:

Applied, thanks

-- 
~Vinod

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel