linux-kernel - Re: [PATCH] virtio: virtio_dma_buf: fix missing parameter documentation

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] [day] [month] [year] [list]

Message-ID: <20250716094357-mutt-send-email-mst@kernel.org>
Date: Wed, 16 Jul 2025 09:45:30 -0400
From: "Michael S. Tsirkin" <mst@...hat.com>
To: WangYuli <wangyuli@...ontech.com>
Cc: jasowang@...hat.com, xuanzhuo@...ux.alibaba.com, eperezma@...hat.com,
	virtualization@...ts.linux.dev, linux-kernel@...r.kernel.org,
	zhanjun@...ontech.com, niecheng1@...ontech.com,
	guanwentao@...ontech.com
Subject: Re: [PATCH] virtio: virtio_dma_buf: fix missing parameter
 documentation

On Mon, Jun 23, 2025 at 02:52:10PM +0800, WangYuli wrote:
> Add missing parameter documentation for virtio_dma_buf_attach()
> function to fix kernel-doc warnings:
> 
> Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'dma_buf' not described in 'virtio_dma_buf_attach'
> Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'attach' not described in 'virtio_dma_buf_attach'
> 
> The function documentation was missing descriptions for both the
> 'dma_buf' and 'attach' parameters. Add proper parameter documentation
> following kernel-doc format.
> 
> Signed-off-by: WangYuli <wangyuli@...ontech.com>


Seems to be a subset of:
[PATCH v2] virtio: Update kerneldoc in drivers/virtio/virtio_dma_buf.c

can you pls review that one?

> ---
>  drivers/virtio/virtio_dma_buf.c | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/drivers/virtio/virtio_dma_buf.c b/drivers/virtio/virtio_dma_buf.c
> index 3fe1d03b0645..95c10632f84a 100644
> --- a/drivers/virtio/virtio_dma_buf.c
> +++ b/drivers/virtio/virtio_dma_buf.c
> @@ -36,6 +36,8 @@ EXPORT_SYMBOL(virtio_dma_buf_export);
>  
>  /**
>   * virtio_dma_buf_attach - mandatory attach callback for virtio dma-bufs
> + * @dma_buf: [in] buffer to attach
> + * @attach: [in] attachment structure
>   */
>  int virtio_dma_buf_attach(struct dma_buf *dma_buf,
>  			  struct dma_buf_attachment *attach)
> -- 
> 2.50.0