2023-02-14 01:03:56

by Yang Li

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

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 <[email protected]>
Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=4051
Signed-off-by: Yang Li <[email protected]>
---
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

2023-02-14 09:20:13

by Peter Korsgaard

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

>>>>> "Yang" == Yang Li <[email protected]> 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 <[email protected]>
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=4051
> Signed-off-by: Yang Li <[email protected]>

Acked-by: Peter Korsgaard <[email protected]>

> ---
> 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

2023-03-17 17:53:31

by Vinod Koul

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

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

Applied, thanks

--
~Vinod