2021-04-15 05:29:41

by Randy Dunlap

Subject: [PATCH] sound: virtio: correct the function name in kernel-doc comment

Fix kernel-doc warning that the wrong function name is used in a
kernel-doc comment:

../sound/virtio/virtio_ctl_msg.c:70: warning: expecting prototype for virtsnd_ctl_msg_request(). Prototype was for virtsnd_ctl_msg_response() instead

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Anton Yakovlev <[email protected]>
Cc: "Michael S. Tsirkin" <[email protected]>
Cc: [email protected]
Cc: [email protected]
---
sound/virtio/virtio_ctl_msg.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20210414.orig/sound/virtio/virtio_ctl_msg.c
+++ linux-next-20210414/sound/virtio/virtio_ctl_msg.c
@@ -61,7 +61,7 @@ void *virtsnd_ctl_msg_request(struct vir
}

/**
- * virtsnd_ctl_msg_request() - Get a pointer to the response header.
+ * virtsnd_ctl_msg_response() - Get a pointer to the response header.
* @msg: Control message.
*
* Context: Any context.

2021-04-15 11:29:52

by Anton Yakovlev

Subject: Re: [PATCH] sound: virtio: correct the function name in kernel-doc comment

On 15.04.2021 07:26, Randy Dunlap wrote:
>
> Fix kernel-doc warning that the wrong function name is used in a
> kernel-doc comment:
>
> ../sound/virtio/virtio_ctl_msg.c:70: warning: expecting prototype for virtsnd_ctl_msg_request(). Prototype was for virtsnd_ctl_msg_response() instead
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Anton Yakovlev <[email protected]>
> Cc: "Michael S. Tsirkin" <[email protected]>
> Cc: [email protected]
> Cc: [email protected]

Thanks for fixing the copy/paste mistake. :)

Reviewed-by: Anton Yakovlev <[email protected]>

> ---
> sound/virtio/virtio_ctl_msg.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-next-20210414.orig/sound/virtio/virtio_ctl_msg.c
> +++ linux-next-20210414/sound/virtio/virtio_ctl_msg.c
> @@ -61,7 +61,7 @@ void *virtsnd_ctl_msg_request(struct vir
> }
>
> /**
> - * virtsnd_ctl_msg_request() - Get a pointer to the response header.
> + * virtsnd_ctl_msg_response() - Get a pointer to the response header.
> * @msg: Control message.
> *
> * Context: Any context.
>

--
Anton Yakovlev
Senior Software Engineer

OpenSynergy GmbH
Rotherstr. 20, 10245 Berlin

2021-05-03 08:21:01

by Michael S. Tsirkin

Subject: Re: [PATCH] sound: virtio: correct the function name in kernel-doc comment

On Wed, Apr 14, 2021 at 10:26:45PM -0700, Randy Dunlap wrote:
> Fix kernel-doc warning that the wrong function name is used in a
> kernel-doc comment:
>
> ../sound/virtio/virtio_ctl_msg.c:70: warning: expecting prototype for virtsnd_ctl_msg_request(). Prototype was for virtsnd_ctl_msg_response() instead
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Anton Yakovlev <[email protected]>
> Cc: "Michael S. Tsirkin" <[email protected]>
> Cc: [email protected]
> Cc: [email protected]

Acked-by: Michael S. Tsirkin <[email protected]>

Pls feel free to apply to the correct tree.

> ---
> sound/virtio/virtio_ctl_msg.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-next-20210414.orig/sound/virtio/virtio_ctl_msg.c
> +++ linux-next-20210414/sound/virtio/virtio_ctl_msg.c
> @@ -61,7 +61,7 @@ void *virtsnd_ctl_msg_request(struct vir
> }
>
> /**
> - * virtsnd_ctl_msg_request() - Get a pointer to the response header.
> + * virtsnd_ctl_msg_response() - Get a pointer to the response header.
> * @msg: Control message.
> *
> * Context: Any context.