linux-kernel - Re: [PATCH] virtio: fix kernel-doc for mapping/free

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: <83709d56-c661-4a7b-a01d-61e122b46099@nvidia.com>
Date: Mon, 10 Nov 2025 20:43:37 +0000
From: Chaitanya Kulkarni <chaitanyak@...dia.com>
To: Kriish Sharma <kriish.sharma2006@...il.com>, "Michael S . Tsirkin"
	<mst@...hat.com>, Jason Wang <jasowang@...hat.com>, Xuan Zhuo
	<xuanzhuo@...ux.alibaba.com>, Eugenio Pérez
	<eperezma@...hat.com>
CC: "virtualization@...ts.linux.dev" <virtualization@...ts.linux.dev>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] virtio: fix kernel-doc for mapping/free_coherent
 functions

On 11/10/25 12:29, Kriish Sharma wrote:
> 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@...il.com>



Looks good.

Reviewed-by: Chaitanya Kulkarni <kch@...dia.com>

-ck