Re: [PATCH] virtio: fix kernel-doc warnings for virtio_device

[kenner azevedi]

Hi team, good evening.

Is there any update regarding this patch?

Thank you very much.

On Thu, Mar 19, 2026 at 11:26 AM Michael S. Tsirkin <mst@xxxxxxxxxx> wrote:
>
> On Thu, Mar 12, 2026 at 06:51:39AM -0400, Kenner de Azevedo dos Santos Miranda wrote:
> > 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@xxxxxxxxx>
>
>
> I will queue this. Thanks!
>
> > ---
> >  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
>