]> git.ipfire.org Git - thirdparty/linux.git/commit
virtio: fix kernel-doc for mapping/free_coherent functions
authorKriish Sharma <kriish.sharma2006@gmail.com>
Mon, 10 Nov 2025 20:29:20 +0000 (20:29 +0000)
committerMichael S. Tsirkin <mst@redhat.com>
Thu, 27 Nov 2025 07:03:05 +0000 (02:03 -0500)
commitf8113000855a8cc2c6d8e19b97a390f1c082285d
tree0edd57de9aa47f98df19f5b917f4c9ae9e8bd478
parente40b6abe0b1247d43bc61942aa7534fca7209e44
virtio: fix kernel-doc for mapping/free_coherent functions

Documentation build reported:

  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

The kernel-doc block for virtqueue_map_free_coherent() omitted the @vaddr parameter, and
the kernel-doc header for virtqueue_map_mapping_error() used the wrong function name
(virtqueue_mapping_error) instead of the actual function name.

This change updates:

  - the function name in the comment to virtqueue_map_mapping_error()
  - adds the missing @vaddr description in the comment for virtqueue_map_free_coherent()

Fixes: b41cb3bcf67f ("virtio: rename dma helpers")
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
Reviewed-by: Chaitanya Kulkarni <kch@nvidia.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
Message-Id: <20251110202920.2250244-1-kriish.sharma2006@gmail.com>
drivers/virtio/virtio_ring.c