mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Michael S. Tsirkin" <mst@redhat.com>
To: linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Cc: "Stephen Rothwell" <sfr@canb.auug.org.au>,
	"Mauro Carvalho Chehab" <mchehab@kernel.org>,
	"Jason Wang" <jasowang@redhat.com>,
	"Xuan Zhuo" <xuanzhuo@linux.alibaba.com>,
	"Eugenio Pérez" <eperezma@redhat.com>,
	virtualization@lists.linux.dev
Subject: [PATCH 7/8] virtio_ring: fix htmldoc warnings
Date: Thu, 13 Nov 2025 04:34:47 -0500	[thread overview]
Message-ID: <975dd9115d8160e8a17a4adc6ae39d05b3cff037.1763026134.git.mst@redhat.com> (raw)
In-Reply-To: <cover.1763026134.git.mst@redhat.com>

We get:
  drivers/virtio/virtio_ring.c:3174 - Missing parameter description for vaddr in virtqueue_map_free_coherent()
  drivers/virtio/virtio_ring.c:3308 - Documentation mismatch: expecting prototype for virtqueue_mapping_error() but the actual

Fix these.

Fixes: bee8c7c24b73 ("virtio: introduce map ops in virtio core")
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
---
 drivers/virtio/virtio_ring.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/virtio/virtio_ring.c b/drivers/virtio/virtio_ring.c
index 7b6205253b46..1b32aa38d26e 100644
--- a/drivers/virtio/virtio_ring.c
+++ b/drivers/virtio/virtio_ring.c
@@ -3166,6 +3166,7 @@ EXPORT_SYMBOL_GPL(virtqueue_map_alloc_coherent);
  * @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 struct virtqueue *_vq,
 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
  *
-- 
MST


  parent reply	other threads:[~2025-11-13  9:34 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-13  9:34 [PATCH 0/8] virtio htmldoc comment fixes Michael S. Tsirkin
2025-11-13  9:34 ` [PATCH 1/8] virtio: fix typo in virtio_device_ready() comment Michael S. Tsirkin
2025-11-13  9:34 ` [PATCH 2/8] virtio: fix whitespace in virtio_config_ops Michael S. Tsirkin
2025-11-13  9:34 ` [PATCH 3/8] virtio: fix grammar in virtio_queue_info docs Michael S. Tsirkin
2025-11-13  9:34 ` [PATCH 4/8] virtio: fix grammar in virtio_map_ops docs Michael S. Tsirkin
2025-11-13  9:34 ` [PATCH 5/8] virtio: standardize Returns documentation style Michael S. Tsirkin
2025-11-13  9:34 ` [PATCH 6/8] virtio: fix virtqueue_set_affinity() docs Michael S. Tsirkin
2025-11-13  9:34 ` Michael S. Tsirkin [this message]
2025-11-13  9:34 ` [PATCH 8/8] virtio: fix map ops comment Michael S. Tsirkin
2025-11-14  0:59 ` [PATCH 0/8] virtio htmldoc comment fixes Jason Wang

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=975dd9115d8160e8a17a4adc6ae39d05b3cff037.1763026134.git.mst@redhat.com \
    --to=mst@redhat.com \
    --cc=corbet@lwn.net \
    --cc=eperezma@redhat.com \
    --cc=jasowang@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=sfr@canb.auug.org.au \
    --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®