2022-05-26 01:30:05

by Jiapeng Chong

Subject: [PATCH] dmaengine: altera: Fix kernel-doc

Fix the following W=1 kernel warnings:

drivers/dma/altera-msgdma.c:927: warning: expecting prototype for
msgdma_dma_remove(). Prototype was for msgdma_remove() instead.

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Jiapeng Chong <[email protected]>
---
drivers/dma/altera-msgdma.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/dma/altera-msgdma.c b/drivers/dma/altera-msgdma.c
index 6f56dfd375e3..bdaac5d62a04 100644
--- a/drivers/dma/altera-msgdma.c
+++ b/drivers/dma/altera-msgdma.c
@@ -918,7 +918,7 @@ static int msgdma_probe(struct platform_device *pdev)
}

/**
- * msgdma_dma_remove - Driver remove function
+ * msgdma_remove() - Driver remove function
* @pdev: Pointer to the platform_device structure
*
* Return: Always '0'
--
2.20.1.7.g153144c

2022-05-27 10:05:32

by Olivier Dautricourt

Subject: Re: [PATCH] dmaengine: altera: Fix kernel-doc

On Wed, May 25, 2022 at 05:33:13PM +0800, Jiapeng Chong wrote:
> Fix the following W=1 kernel warnings:
>
> drivers/dma/altera-msgdma.c:927: warning: expecting prototype for
> msgdma_dma_remove(). Prototype was for msgdma_remove() instead.
>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Jiapeng Chong <[email protected]>
> ---
> drivers/dma/altera-msgdma.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/dma/altera-msgdma.c b/drivers/dma/altera-msgdma.c
> index 6f56dfd375e3..bdaac5d62a04 100644
> --- a/drivers/dma/altera-msgdma.c
> +++ b/drivers/dma/altera-msgdma.c
> @@ -918,7 +918,7 @@ static int msgdma_probe(struct platform_device *pdev)
> }
>
> /**
> - * msgdma_dma_remove - Driver remove function
> + * msgdma_remove() - Driver remove function
> * @pdev: Pointer to the platform_device structure
> *
> * Return: Always '0'
> --
> 2.20.1.7.g153144c
>

Hello, thanks for reporting.

I notice now that another doc entry is misnamed:

drivers/dma/altera-msgdma.c:758: warning: expecting prototype for
msgdma_chan_remove(). Prototype was for msgdma_dev_remove() instead

Is it possible for you to fix this aswell ?
I also suggest using the full name of the driver in the commit message:
dmaengine: altera-msgdma: ...


Kr,


Olivier

2022-07-06 05:46:43

by Vinod Koul

Subject: Re: [PATCH] dmaengine: altera: Fix kernel-doc

On 25-05-22, 17:33, Jiapeng Chong wrote:
> Fix the following W=1 kernel warnings:
>
> drivers/dma/altera-msgdma.c:927: warning: expecting prototype for
> msgdma_dma_remove(). Prototype was for msgdma_remove() instead.

Commit title should describe the change and not the effect, pls revise

>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Jiapeng Chong <[email protected]>
> ---
> drivers/dma/altera-msgdma.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/dma/altera-msgdma.c b/drivers/dma/altera-msgdma.c
> index 6f56dfd375e3..bdaac5d62a04 100644
> --- a/drivers/dma/altera-msgdma.c
> +++ b/drivers/dma/altera-msgdma.c
> @@ -918,7 +918,7 @@ static int msgdma_probe(struct platform_device *pdev)
> }
>
> /**
> - * msgdma_dma_remove - Driver remove function
> + * msgdma_remove() - Driver remove function
> * @pdev: Pointer to the platform_device structure
> *
> * Return: Always '0'
> --
> 2.20.1.7.g153144c

--
~Vinod