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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <Yo/f1F5wf1Tpaqoi@olivier-3493erg>
Date:   Thu, 26 May 2022 22:15:16 +0200
From:   Olivier dautricourt <olivierdautricourt@...il.com>
To:     Jiapeng Chong <jiapeng.chong@...ux.alibaba.com>
Cc:     sr@...x.de, vkoul@...nel.org, dmaengine@...r.kernel.org,
        linux-kernel@...r.kernel.org, Abaci Robot <abaci@...ux.alibaba.com>
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 <abaci@...ux.alibaba.com>
> Signed-off-by: Jiapeng Chong <jiapeng.chong@...ux.alibaba.com>
> ---
>  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