From: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora•com>
To: "Ricardo Cañuelo" <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
Date: Tue, 20 Dec 2022 10:48:27 +0100 [thread overview]
Message-ID: <c0540d38-090a-abb8-654d-db61ce356349@collabora.com> (raw)
In-Reply-To: <20221220073709.2687151-1-ricardo.canuelo@collabora.com>
Il 20/12/22 08:37, Ricardo Cañuelo ha scritto:
> Fixes two warning messages when building htmldocs:
>
> warning: duplicate section name 'Note'
> warning: expecting prototype for virtio_config_ops().
> Prototype was for vq_callback_t() instead
>
> Signed-off-by: Ricardo Cañuelo <ricardo.canuelo@collabora•com>
> ---
> include/linux/virtio_config.h | 9 +++++----
> 1 file changed, 5 insertions(+), 4 deletions(-)
>
> 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;
> };
>
> +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 speaking,
> * 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.
To avoid getting the same warning in the future (developer mistake and/or other
reasons), what about dropping this instance of "Note:" entirely?
I think that something like...
the dev->feature bits if it wants. Note that despite the name....
Cheers,
Angelo
next prev parent reply other threads:[~2022-12-20 9:48 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-20 7:37 [PATCH] virtio: fix virtio_config_ops kerneldocs Ricardo Cañuelo
2022-12-20 9:12 ` Bagas Sanjaya
2022-12-20 9:54 ` Ricardo Cañuelo
2022-12-20 10:25 ` Michael S. Tsirkin
2022-12-20 11:30 ` Ricardo Cañuelo
2022-12-20 9:48 ` AngeloGioacchino Del Regno [this message]
2022-12-20 10:01 ` Ricardo Cañuelo
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=c0540d38-090a-abb8-654d-db61ce356349@collabora.com \
--to=angelogioacchino.delregno@collabora$(echo .)com \
--cc=kernel@collabora$(echo .)com \
--cc=linux-kernel@vger$(echo .)kernel.org \
--cc=linux-next@vger$(echo .)kernel.org \
--cc=mst@redhat$(echo .)com \
--cc=ricardo.canuelo@collabora$(echo .)com \
--cc=sfr@canb$(echo .)auug.org.au \
--cc=virtualization@lists$(echo .)linux-foundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox