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

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

[Randy Dunlap]

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@infradead.org>
---
Cc: "Michael S. Tsirkin" <mst@redhat.com>
Cc: Jason Wang <jasowang@redhat.com>
Cc: Xuan Zhuo <xuanzhuo@linux.alibaba.com>
Cc: Eugenio Pérez <eperezma@redhat.com>
Cc: virtualization@lists.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
  *

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

[Michael S. Tsirkin]

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@infradead.org>

Thanks, already fixed in my tree.

> ---
> Cc: "Michael S. Tsirkin" <mst@redhat.com>
> Cc: Jason Wang <jasowang@redhat.com>
> Cc: Xuan Zhuo <xuanzhuo@linux.alibaba.com>
> Cc: Eugenio Pérez <eperezma@redhat.com>
> Cc: virtualization@lists.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
>   *