[PATCH 0/8] virtio htmldoc comment fixes

Michael S. Tsirkin posted 8 patches 3 months ago
drivers/virtio/virtio_ring.c  |  3 ++-
include/linux/virtio_config.h | 22 +++++++++++-----------
2 files changed, 13 insertions(+), 12 deletions(-)
[PATCH 0/8] virtio htmldoc comment fixes
Posted by Michael S. Tsirkin 3 months ago
This fixes warnings reported by htmldoc as well
as a couple of others I found while reading the code.

Jason, I found a bunch more issues with the map ops patches, like weird

/*
 * XXX
 *
 */

multiline comments, weirdly formatted return, inconsistent use of
"the" for some parameters but not others.

Pls take a look and address.

Michael S. Tsirkin (8):
  virtio: fix typo in virtio_device_ready() comment
  virtio: fix whitespace in virtio_config_ops
  virtio: fix grammar in virtio_queue_info docs
  virtio: fix grammar in virtio_map_ops docs
  virtio: standardize Returns documentation style
  virtio: fix virtqueue_set_affinity() docs
  virtio_ring: fix htmldoc warnings
  virtio: fix map ops comment

 drivers/virtio/virtio_ring.c  |  3 ++-
 include/linux/virtio_config.h | 22 +++++++++++-----------
 2 files changed, 13 insertions(+), 12 deletions(-)

-- 
MST
Re: [PATCH 0/8] virtio htmldoc comment fixes
Posted by Jason Wang 2 months, 4 weeks ago
On Thu, Nov 13, 2025 at 5:34 PM Michael S. Tsirkin <mst@redhat.com> wrote:
>
> This fixes warnings reported by htmldoc as well
> as a couple of others I found while reading the code.
>
> Jason, I found a bunch more issues with the map ops patches, like weird

Thanks.

>
> /*
>  * XXX
>  *
>  */
>
> multiline comments, weirdly formatted return, inconsistent use of
> "the" for some parameters but not others.
>
> Pls take a look and address.


Acked-by: Jason Wang <jasowang@redhat.com>

>
> Michael S. Tsirkin (8):
>   virtio: fix typo in virtio_device_ready() comment
>   virtio: fix whitespace in virtio_config_ops
>   virtio: fix grammar in virtio_queue_info docs
>   virtio: fix grammar in virtio_map_ops docs
>   virtio: standardize Returns documentation style
>   virtio: fix virtqueue_set_affinity() docs
>   virtio_ring: fix htmldoc warnings
>   virtio: fix map ops comment
>
>  drivers/virtio/virtio_ring.c  |  3 ++-
>  include/linux/virtio_config.h | 22 +++++++++++-----------
>  2 files changed, 13 insertions(+), 12 deletions(-)
>
> --
> MST
>