From: Chaitanya Kulkarni <chaitanyak@nvidia.com>
To: "Kriish Sharma" <kriish.sharma2006@gmail.com>,
"Michael S . Tsirkin" <mst@redhat.com>,
"Jason Wang" <jasowang@redhat.com>,
"Xuan Zhuo" <xuanzhuo@linux.alibaba.com>,
"Eugenio Pérez" <eperezma@redhat.com>
Cc: "virtualization@lists.linux.dev" <virtualization@lists.linux.dev>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] virtio: fix kernel-doc for mapping/free_coherent functions
Date: Mon, 10 Nov 2025 20:43:37 +0000 [thread overview]
Message-ID: <83709d56-c661-4a7b-a01d-61e122b46099@nvidia.com> (raw)
In-Reply-To: <20251110202920.2250244-1-kriish.sharma2006@gmail.com>
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@gmail.com>
Looks good.
Reviewed-by: Chaitanya Kulkarni <kch@nvidia.com>
-ck
prev parent reply other threads:[~2025-11-10 20:43 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-10 20:29 Kriish Sharma
2025-11-10 20:43 ` Chaitanya Kulkarni [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83709d56-c661-4a7b-a01d-61e122b46099@nvidia.com \
--to=chaitanyak@nvidia.com \
--cc=eperezma@redhat.com \
--cc=jasowang@redhat.com \
--cc=kriish.sharma2006@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mst@redhat.com \
--cc=virtualization@lists.linux.dev \
--cc=xuanzhuo@linux.alibaba.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®