2021-06-08 09:41:23

by Yang Li

[permalink] [raw]
Subject: [PATCH] dmaengine: xilinx: dpdma: fix kernel-doc

Fix function name in xilinx/xilinx_dpdma.c kernel-doc comment
to remove a warning found by clang(make W=1 LLVM=1).

drivers/dma/xilinx/xilinx_dpdma.c:935: warning: expecting prototype for
xilinx_dpdma_chan_no_ostand(). Prototype was for
xilinx_dpdma_chan_notify_no_ostand() instead.

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
drivers/dma/xilinx/xilinx_dpdma.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/dma/xilinx/xilinx_dpdma.c b/drivers/dma/xilinx/xilinx_dpdma.c
index 70b29bd..0c8739a 100644
--- a/drivers/dma/xilinx/xilinx_dpdma.c
+++ b/drivers/dma/xilinx/xilinx_dpdma.c
@@ -915,7 +915,7 @@ static u32 xilinx_dpdma_chan_ostand(struct xilinx_dpdma_chan *chan)
}

/**
- * xilinx_dpdma_chan_no_ostand - Notify no outstanding transaction event
+ * xilinx_dpdma_chan_notify_no_ostand - Notify no outstanding transaction event
* @chan: DPDMA channel
*
* Notify waiters for no outstanding event, so waiters can stop the channel
--
1.8.3.1


2021-06-09 10:10:05

by Nick Desaulniers

[permalink] [raw]
Subject: Re: [PATCH] dmaengine: xilinx: dpdma: fix kernel-doc

On Tue, Jun 8, 2021 at 2:38 AM Yang Li <[email protected]> wrote:
>
> Fix function name in xilinx/xilinx_dpdma.c kernel-doc comment
> to remove a warning found by clang(make W=1 LLVM=1).
>
> drivers/dma/xilinx/xilinx_dpdma.c:935: warning: expecting prototype for
> xilinx_dpdma_chan_no_ostand(). Prototype was for
> xilinx_dpdma_chan_notify_no_ostand() instead.

xilinx_dpdma_chan_notify_no_ostand has static linkage, clang shouldn't
be emitting such a warning for this function. Which tree was Abaci
run on? Do you have the original report? This warning doesn't look
right to me.

Again, the diff seems fine, but the commit message does not.

>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Yang Li <[email protected]>
> ---
> drivers/dma/xilinx/xilinx_dpdma.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/dma/xilinx/xilinx_dpdma.c b/drivers/dma/xilinx/xilinx_dpdma.c
> index 70b29bd..0c8739a 100644
> --- a/drivers/dma/xilinx/xilinx_dpdma.c
> +++ b/drivers/dma/xilinx/xilinx_dpdma.c
> @@ -915,7 +915,7 @@ static u32 xilinx_dpdma_chan_ostand(struct xilinx_dpdma_chan *chan)
> }
>
> /**
> - * xilinx_dpdma_chan_no_ostand - Notify no outstanding transaction event
> + * xilinx_dpdma_chan_notify_no_ostand - Notify no outstanding transaction event
> * @chan: DPDMA channel
> *
> * Notify waiters for no outstanding event, so waiters can stop the channel
> --
> 1.8.3.1
>


--
Thanks,
~Nick Desaulniers