linux-kernel - Re: [PATCH] virtio_ring: kernel-doc: fix function name, function param warnings

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: <20251116013303-mutt-send-email-mst@kernel.org>
Date: Sun, 16 Nov 2025 01:33:17 -0500
From: "Michael S. Tsirkin" <mst@...hat.com>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Jason Wang <jasowang@...hat.com>,
	Xuan Zhuo <xuanzhuo@...ux.alibaba.com>,
	Eugenio Pérez <eperezma@...hat.com>,
	virtualization@...ts.linux.dev
Subject: Re: [PATCH] virtio_ring: kernel-doc: fix function name, function
 param warnings

On Sat, Nov 15, 2025 at 02:45:33PM -0800, Randy Dunlap wrote:
> Add description for the function parameter @vaddr.
> Correct the function name in a kernel-doc comment.
> 
> Fixes these warning:
> WARNING: drivers/virtio/virtio_ring.c:3174 function parameter 'vaddr' not
>  described in 'virtqueue_map_free_coherent'
> WARNING: drivers/virtio/virtio_ring.c:3308 expecting prototype for
>  virtqueue_mapping_error(). Prototype was for virtqueue_map_mapping_error()
>  instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>

Thanks, already fixed in my tree.

> ---
> Cc: "Michael S. Tsirkin" <mst@...hat.com>
> Cc: Jason Wang <jasowang@...hat.com>
> Cc: Xuan Zhuo <xuanzhuo@...ux.alibaba.com>
> Cc: Eugenio Pérez <eperezma@...hat.com>
> Cc: virtualization@...ts.linux.dev
> ---
>  drivers/virtio/virtio_ring.c |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> --- linux-next-20251114.orig/drivers/virtio/virtio_ring.c
> +++ linux-next-20251114/drivers/virtio/virtio_ring.c
> @@ -3166,6 +3166,7 @@ EXPORT_SYMBOL_GPL(virtqueue_map_alloc_co
>   * @vdev: the virtio device we are talking to
>   * @map: metadata for performing mapping
>   * @size: the size of the buffer
> + * @vaddr: virtual address of the buffer
>   * @map_handle: the mapped address that needs to be freed
>   *
>   */
> @@ -3299,7 +3300,7 @@ void virtqueue_unmap_single_attrs(const
>  EXPORT_SYMBOL_GPL(virtqueue_unmap_single_attrs);
>  
>  /**
> - * virtqueue_mapping_error - check dma address
> + * virtqueue_map_mapping_error - check dma address
>   * @_vq: the struct virtqueue we're talking about.
>   * @addr: DMA address
>   *