linux-kernel - Re: [PATCH v2] virtio: Describe @map and @vmap members in virtio

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20251226140725-mutt-send-email-mst@kernel.org>
Date: Fri, 26 Dec 2025 14:13:00 -0500
From: "Michael S. Tsirkin" <mst@...hat.com>
To: Bagas Sanjaya <bagasdotme@...il.com>
Cc: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linux Virtualization <virtualization@...ts.linux.dev>,
	Jason Wang <jasowang@...hat.com>,
	Xuan Zhuo <xuanzhuo@...ux.alibaba.com>,
	Eugenio Pérez <eperezma@...hat.com>
Subject: Re: [PATCH v2] virtio: Describe @map and @vmap members in
 virtio_device struct

On Fri, Dec 19, 2025 at 10:16:47AM +0700, Bagas Sanjaya wrote:
> Sphinx reports kernel-doc warnings:
> 
> WARNING: ./include/linux/virtio.h:181 struct member 'map' not described in 'virtio_device'
> WARNING: ./include/linux/virtio.h:181 struct member 'vmap' not described in 'virtio_device'
> 
> Describe these members.
> 
> Fixes: bee8c7c24b7373 ("virtio: introduce map ops in virtio core")
> Acked-by: Michael S. Tsirkin <mst@...hat.com>
> Acked-by: Jason Wang <jasowang@...hat.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>


Well I was going to apply and now I have second thoughts.
The patch does describe the members, it just does not
describe them well.
for example,


> ---
> This patch is split from kernel-doc fixup series [1].
> 
> Changes since v1 [2]:
> 
>   - Apply review trailers (Michael, Jason)
> 
> [1]: https://lore.kernel.org/lkml/20251215113903.46555-1-bagasdotme@gmail.com/
> [2]: https://lore.kernel.org/lkml/20251215113903.46555-7-bagasdotme@gmail.com/
> 
>  include/linux/virtio.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/include/linux/virtio.h b/include/linux/virtio.h
> index 132a474e59140a..68ead8fda9c921 100644
> --- a/include/linux/virtio.h
> +++ b/include/linux/virtio.h
> @@ -150,11 +150,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: configuration ops for device's mapping buffer

there's no "mapping buffer" that needs configuration.
the type tells it all:
 * struct virtio_map_ops - operations for mapping buffer for a virtio device


>   * @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.
>   * @priv: private pointer for the driver's use.
> + * @vmap: device virtual map

this one is not a "virtual map" either.
more a "device or domain used for mapping memory"

>   * @debugfs_dir: debugfs directory entry.
>   * @debugfs_filter_features: features to be filtered set by debugfs.
>   */
> 
> base-commit: ea1013c1539270e372fc99854bc6e4d94eaeff66
> -- 
> An old man doll... just what I always wanted! - Clara