linux-kernel - Re: [PATCH] virtio: Add missing kerneldoc for virtio_dma_buf

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <879d1fa7-04a5-403c-8d23-76631a67f560@kernel.org>
Date: Fri, 4 Jul 2025 17:19:49 +0200
From: Krzysztof Kozlowski <krzk@...nel.org>
To: jiang.peng9@....com.cn, jasowang@...hat.com, xuanzhuo@...ux.alibaba.com
Cc: mst@...hat.com, eperezma@...hat.com, sumit.semwal@...aro.org,
 christian.koenig@....com, virtualization@...ts.linux.dev,
 linux-kernel@...r.kernel.org, linux-media@...r.kernel.org,
 dri-devel@...ts.freedesktop.org, linaro-mm-sig@...ts.linaro.org,
 xu.xin16@....com.cn, yang.yang29@....com.cn
Subject: Re: [PATCH] virtio: Add missing kerneldoc for virtio_dma_buf_attach

On 04/07/2025 09:20, jiang.peng9@....com.cn wrote:
> From: Peng Jiang <jiang.peng9@....com.cn>
> 
> Add kerneldoc for 'virtio_dma_buf_attach' function to fix W=1 warnings:
> 
> drivers/virtio/virtio_dma_buf.c:41 function parameter 'dma_buf' not described in 'virtio_dma_buf_attach'
> drivers/virtio/virtio_dma_buf.c:41 function parameter 'attach' not described in 'virtio_dma_buf_attach'
> 
> Signed-off-by: Peng Jiang <jiang.peng9@....com.cn>
> ---
>  drivers/virtio/virtio_dma_buf.c | 11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/virtio/virtio_dma_buf.c b/drivers/virtio/virtio_dma_buf.c
> index 3fe1d03b0645..18d261ba5197 100644
> --- a/drivers/virtio/virtio_dma_buf.c
> +++ b/drivers/virtio/virtio_dma_buf.c
> @@ -35,7 +35,16 @@ struct dma_buf *virtio_dma_buf_export
>  EXPORT_SYMBOL(virtio_dma_buf_export);
> 
>  /**
> - * virtio_dma_buf_attach - mandatory attach callback for virtio dma-bufs
> + * virtio_dma_buf_attach - Mandatory attach callback for virtio dma-bufs

Read kernel-doc.rst. Missing ()

> + * @dma_buf: Pointer to the shared dma-buf structure
> + * @attach: Pointer to the newly created attachment metadata
> + *
> + * Description: Implements the standard dma-buf attach operation for virtio devices.

That's not kerneldoc. Which part of kernel-doc document documents such
syntax?


> + *              Retrieves virtio-specific operations through container_of macro,
> + *              then invokes device-specific attach callback if present.
Best regards,
Krzysztof