All of lore.kernel.org
 help / color / mirror / Atom feed
From: Kenner de Azevedo dos Santos Miranda <kenner.linuxdev@gmail.com>
To: mst@redhat.com, jasowang@redhat.com
Cc: xuanzhuo@linux.alibaba.com, eperezma@redhat.com,
	virtualization@lists.linux.dev, linux-kernel@vger.kernel.org,
	kenner.linuxdev@gmail.com
Subject: [PATCH] virtio: fix kernel-doc warnings for virtio_device
Date: Thu, 12 Mar 2026 06:51:39 -0400	[thread overview]
Message-ID: <20260312105139.60811-1-kenner.linuxdev@gmail.com> (raw)

The following warnings were reported when running 'make htmldocs':

  WARNING: ./include/linux/virtio.h:188 struct member 'map'
  not described in 'virtio_device'

  WARNING: ./include/linux/virtio.h:188 struct member
  'VIRTIO_DECLARE_FEATURES(features' not described in
  'virtio_device'

  WARNING: ./include/linux/virtio.h:188 struct member 'vmap'
  not described in 'virtio_device'

Document the map and vmap fields in struct virtio_device.

Also avoid kernel-doc confusion caused by the VIRTIO_DECLARE_FEATURES()
macro by documenting the logical @features field.

After these changes, running 'make htmldocs' no longer reports warnings
for map, vmap, or VIRTIO_DECLARE_FEATURES().

Signed-off-by: Kenner de Azevedo dos Santos Miranda <kenner.linuxdev@gmail.com>
---
 include/linux/virtio.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/include/linux/virtio.h b/include/linux/virtio.h
index 3bbc4cb6a672..074d36453177 100644
--- a/include/linux/virtio.h
+++ b/include/linux/virtio.h
@@ -157,11 +157,13 @@ struct virtio_admin_cmd {
  * @id: the device type identification (used to match it with a driver).
  * @config: the configuration ops for this device.
  * @vringh_config: configuration ops for host vrings.
+ * @map: virtio specific mapping operations used by the device or transport.
  * @vqs: the list of virtqueues for this device.
  * @features: the 64 lower features supported by both driver and device.
  * @features_array: the full features space supported by both driver and
- *		    device.
+ *                device.
  * @priv: private pointer for the driver's use.
+ * @vmap: mapping token passed to virtio mapping helpers and transport ops.
  * @debugfs_dir: debugfs directory entry.
  * @debugfs_filter_features: features to be filtered set by debugfs.
  */
@@ -179,6 +181,7 @@ struct virtio_device {
 	const struct vringh_config_ops *vringh_config;
 	const struct virtio_map_ops *map;
 	struct list_head vqs;
+       /* See @features */
 	VIRTIO_DECLARE_FEATURES(features);
 	void *priv;
 	union virtio_map vmap;
-- 
2.43.0


             reply	other threads:[~2026-03-12 10:51 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-12 10:51 Kenner de Azevedo dos Santos Miranda [this message]
2026-03-19 15:26 ` [PATCH] virtio: fix kernel-doc warnings for virtio_device Michael S. Tsirkin
2026-04-26 22:29   ` kenner azevedi

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=20260312105139.60811-1-kenner.linuxdev@gmail.com \
    --to=kenner.linuxdev@gmail.com \
    --cc=eperezma@redhat.com \
    --cc=jasowang@redhat.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.