Re: [PATCH] rpmsg: virtio: fix compilation warning for virtio_rpmsg_channel description

[Mathieu Poirier]

On Fri, Jul 31, 2020 at 09:48:50AM +0200, Arnaud Pouliquen wrote:
> Complete the virtio_rpmsg_channel structure description to fix a
> compilation warning with W=1 option:
> 
> drivers/rpmsg/virtio_rpmsg_bus.c:95: warning: Cannot understand
>  * @vrp: the remote processor this channel belongs to
> 
> Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@xxxxxx>
> ---
>  drivers/rpmsg/virtio_rpmsg_bus.c | 7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)

Reviewed-by: Mathieu Poirier <mathieu.poirier@xxxxxxxxxx>

> 
> diff --git a/drivers/rpmsg/virtio_rpmsg_bus.c b/drivers/rpmsg/virtio_rpmsg_bus.c
> index 9006fc7f73d0..7d7ed4e5cce7 100644
> --- a/drivers/rpmsg/virtio_rpmsg_bus.c
> +++ b/drivers/rpmsg/virtio_rpmsg_bus.c
> @@ -123,7 +123,12 @@ enum rpmsg_ns_flags {
>  };
>  
>  /**
> - * @vrp: the remote processor this channel belongs to
> + * struct virtio_rpmsg_channel - rpmsg channel descriptor
> + * @rpdev: the rpmsg channel device
> + * @vrp: the virtio remote processor device this channel belongs to
> + *
> + * This structure stores the channel that links the rpmsg device to the virtio
> + * remote processor device.
>   */
>  struct virtio_rpmsg_channel {
>  	struct rpmsg_device rpdev;
> -- 
> 2.17.1
>