Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Tue, 20 Dec 2022 16:12:22 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     Ricardo =?utf-8?Q?Ca=C3=B1uelo?= <ricardo.canuelo@collabora.com>,
        mst@redhat.com
Cc:     sfr@canb.auug.org.au, linux-kernel@vger.kernel.org,
        linux-next@vger.kernel.org,
        virtualization@lists.linux-foundation.org, kernel@collabora.com
Subject: Re: [PATCH] virtio: fix virtio_config_ops kerneldocs
Message-ID: <Y6F8dlRQbOzIvJff@debian.me>
References: <20221220073709.2687151-1-ricardo.canuelo@collabora.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="OXVyoOujoaT2mOLY"
Content-Disposition: inline
In-Reply-To: <20221220073709.2687151-1-ricardo.canuelo@collabora.com>
Precedence: bulk


--OXVyoOujoaT2mOLY
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Tue, Dec 20, 2022 at 08:37:09AM +0100, Ricardo Ca=C3=B1uelo wrote:
> Fixes two warning messages when building htmldocs:
>=20
>     warning: duplicate section name 'Note'
>     warning: expecting prototype for virtio_config_ops().
>              Prototype was for vq_callback_t() instead
>=20

Describe the steps needed to fix both warnings above. I see in the diff tha=
t:

  * move vq_callback_t() declaration above;
  * match entity type of virtio_config_ops; and
  * reformat @finalize_features description.

> Signed-off-by: Ricardo Ca=C3=B1uelo <ricardo.canuelo@collabora.com>

You need to add appropriate tags:

Link: https://lore.kernel.org/linux-next/20221220105956.4786852d@canb.auug.=
org.au/
Fixes: 333723e8bc393d ("docs: driver-api: virtio: virtio on Linux")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>

> ---
>  include/linux/virtio_config.h | 9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)
>=20
> diff --git a/include/linux/virtio_config.h b/include/linux/virtio_config.h
> index 4b517649cfe8..f9a33062c089 100644
> --- a/include/linux/virtio_config.h
> +++ b/include/linux/virtio_config.h
> @@ -16,8 +16,10 @@ struct virtio_shm_region {
>  	u64 len;
>  };
> =20
> +typedef void vq_callback_t(struct virtqueue *);
> +
>  /**
> - * virtio_config_ops - operations for configuring a virtio device
> + * struct virtio_config_ops - operations for configuring a virtio device
>   * Note: Do not assume that a transport implements all of the operations
>   *       getting/setting a value as a simple read/write! Generally speak=
ing,
>   *       any of @get/@set, @get_status/@set_status, or @get_features/
> @@ -68,8 +70,8 @@ struct virtio_shm_region {
>   * @finalize_features: confirm what device features we'll be using.
>   *	vdev: the virtio_device
>   *	This sends the driver feature bits to the device: it can change
> - *	the dev->feature bits if it wants.
> - * Note: despite the name this can be called any number of times.
> + *	the dev->feature bits if it wants. Note: despite the name this
> + *	can be called any number of times.
>   *	Returns 0 on success or error status
>   * @bus_name: return the bus name associated with the device (optional)
>   *	vdev: the virtio_device
> @@ -91,7 +93,6 @@ struct virtio_shm_region {
>   *	If disable_vq_and_reset is set, then enable_vq_after_reset must also =
be
>   *	set.
>   */
> -typedef void vq_callback_t(struct virtqueue *);
>  struct virtio_config_ops {
>  	void (*get)(struct virtio_device *vdev, unsigned offset,
>  		    void *buf, unsigned len);

Anyway, the warnings went away, thanks for the fixup!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>=20

--=20
An old man doll... just what I always wanted! - Clara

--OXVyoOujoaT2mOLY
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEARYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCY6F8cQAKCRD2uYlJVVFO
oxkOAPoDk/Uh8Mw4Jr/AK7/a8Ni8OUD9QlZLyRg1r48aQY1vEwEAu6CUsbAL6IQ8
5BShjyWYVRQWZHKkPXbQ4+z/NUbv9go=
=lyv2
-----END PGP SIGNATURE-----

--OXVyoOujoaT2mOLY--