Commit b2ffaa67 authored Mar 31, 2023 by Simon Horman Committed by Michael S. Tsirkin Apr 21, 2023

vringh: address kdoc warnings



Address some minor kdoc warnings in vring.h.
* Place kdoc for 'struct vringh_config_ops' immediately before the structure
* Add missing documentation of members of 'vringh_iov' and 'vringh_kiov'

Warnings flagged by:
 $ ./scripts/kernel-doc -none include/linux/vringh.h
 include/linux/vringh.h:68: error: Cannot parse struct or union!
 include/linux/vringh.h:92: warning: Function parameter or member 'iov' not described in 'vringh_iov'
 include/linux/vringh.h:92: warning: Function parameter or member 'consumed' not described in 'vringh_iov'
 include/linux/vringh.h:92: warning: Function parameter or member 'i' not described in 'vringh_iov'
 include/linux/vringh.h:92: warning: Function parameter or member 'used' not described in 'vringh_iov'
 include/linux/vringh.h:92: warning: Function parameter or member 'max_num' not described in 'vringh_iov'
 include/linux/vringh.h:104: warning: Function parameter or member 'iov' not described in 'vringh_kiov'
 include/linux/vringh.h:104: warning: Function parameter or member 'consumed' not described in 'vringh_kiov'
 include/linux/vringh.h:104: warning: Function parameter or member 'i' not described in 'vringh_kiov'
 include/linux/vringh.h:104: warning: Function parameter or member 'used' not described in 'vringh_kiov'
 include/linux/vringh.h:104: warning: Function parameter or member 'max_num' not described in 'vringh_kiov'

Signed-off-by: Simon Horman <horms@kernel.org>
Message-Id: <20230331-vhost-fixes-v1-2-1f046e735b9e@kernel.org>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>

parent 9be5d2d4

include/linux/vringh.h

+15 −2

Original line number	Diff line number	Diff line
		@@ -57,6 +57,9 @@ struct vringh {
		void (notify)(struct vringh );
		};

		struct virtio_device;
		typedef void vrh_callback_t(struct virtio_device , struct vringh );

		/**
		* struct vringh_config_ops - ops for creating a host vring from a virtio driver
		* @find_vrhs: find the host vrings and instantiate them
		@@ -68,8 +71,6 @@ struct vringh {
		* Returns 0 on success or error status
		* @del_vrhs: free the host vrings found by find_vrhs().
		*/
		struct virtio_device;
		typedef void vrh_callback_t(struct virtio_device , struct vringh );
		struct vringh_config_ops {
		int (find_vrhs)(struct virtio_device vdev, unsigned nhvrs,
		struct vringh vrhs[], vrh_callback_t callbacks[]);
		@@ -84,6 +85,12 @@ struct vringh_range {

		/**
		* struct vringh_iov - iovec mangler.
		* @iov: array of iovecs to operate on
		* @consumed: number of bytes consumed within iov[i]
		* @i: index of current iovec
		* @used: number of iovecs present in @iov
		* @max_num: maximum number of iovecs.
		* corresponds to allocated memory of @iov
		*
		* Mangles iovec in place, and restores it.
		* Remaining data is iov + i, of used - i elements.
		@@ -96,6 +103,12 @@ struct vringh_iov {

		/**
		* struct vringh_kiov - kvec mangler.
		* @iov: array of iovecs to operate on
		* @consumed: number of bytes consumed within iov[i]
		* @i: index of current iovec
		* @used: number of iovecs present in @iov
		* @max_num: maximum number of iovecs.
		* corresponds to allocated memory of @iov
		*
		* Mangles kvec in place, and restores it.
		* Remaining data is iov + i, of used - i elements.