2021-05-20 14:10:34

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH] media: davinci: fix two kernel-doc comments

A typo there is causing two warnings:
drivers/media/platform/davinci/vpif_display.c:114: warning: Function parameter or member 'nplanes' not described in 'vpif_buffer_queue_setup'
drivers/media/platform/davinci/vpif_capture.c:112: warning: Function parameter or member 'nplanes' not described in 'vpif_buffer_queue_setup'

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
drivers/media/platform/davinci/vpif_capture.c | 2 +-
drivers/media/platform/davinci/vpif_display.c | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/media/platform/davinci/vpif_capture.c b/drivers/media/platform/davinci/vpif_capture.c
index 8d2e165bf7de..c034e25dd9aa 100644
--- a/drivers/media/platform/davinci/vpif_capture.c
+++ b/drivers/media/platform/davinci/vpif_capture.c
@@ -99,7 +99,7 @@ static int vpif_buffer_prepare(struct vb2_buffer *vb)
* vpif_buffer_queue_setup : Callback function for buffer setup.
* @vq: vb2_queue ptr
* @nbuffers: ptr to number of buffers requested by application
- * @nplanes:: contains number of distinct video planes needed to hold a frame
+ * @nplanes: contains number of distinct video planes needed to hold a frame
* @sizes: contains the size (in bytes) of each plane.
* @alloc_devs: ptr to allocation context
*
diff --git a/drivers/media/platform/davinci/vpif_display.c b/drivers/media/platform/davinci/vpif_display.c
index e5f61d9b221d..59f6b782e104 100644
--- a/drivers/media/platform/davinci/vpif_display.c
+++ b/drivers/media/platform/davinci/vpif_display.c
@@ -101,7 +101,7 @@ static int vpif_buffer_prepare(struct vb2_buffer *vb)
* vpif_buffer_queue_setup : Callback function for buffer setup.
* @vq: vb2_queue ptr
* @nbuffers: ptr to number of buffers requested by application
- * @nplanes:: contains number of distinct video planes needed to hold a frame
+ * @nplanes: contains number of distinct video planes needed to hold a frame
* @sizes: contains the size (in bytes) of each plane.
* @alloc_devs: ptr to allocation context
*
--
2.31.1


2021-05-21 06:39:57

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] media: davinci: fix two kernel-doc comments

On 5/20/21 7:07 AM, Mauro Carvalho Chehab wrote:
> A typo there is causing two warnings:
> drivers/media/platform/davinci/vpif_display.c:114: warning: Function parameter or member 'nplanes' not described in 'vpif_buffer_queue_setup'
> drivers/media/platform/davinci/vpif_capture.c:112: warning: Function parameter or member 'nplanes' not described in 'vpif_buffer_queue_setup'
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> drivers/media/platform/davinci/vpif_capture.c | 2 +-
> drivers/media/platform/davinci/vpif_display.c | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/media/platform/davinci/vpif_capture.c b/drivers/media/platform/davinci/vpif_capture.c
> index 8d2e165bf7de..c034e25dd9aa 100644
> --- a/drivers/media/platform/davinci/vpif_capture.c
> +++ b/drivers/media/platform/davinci/vpif_capture.c
> @@ -99,7 +99,7 @@ static int vpif_buffer_prepare(struct vb2_buffer *vb)
> * vpif_buffer_queue_setup : Callback function for buffer setup.

* vpif_buffer_queue_setup - Callback ...

> * @vq: vb2_queue ptr
> * @nbuffers: ptr to number of buffers requested by application
> - * @nplanes:: contains number of distinct video planes needed to hold a frame
> + * @nplanes: contains number of distinct video planes needed to hold a frame
> * @sizes: contains the size (in bytes) of each plane.
> * @alloc_devs: ptr to allocation context
> *
> diff --git a/drivers/media/platform/davinci/vpif_display.c b/drivers/media/platform/davinci/vpif_display.c
> index e5f61d9b221d..59f6b782e104 100644
> --- a/drivers/media/platform/davinci/vpif_display.c
> +++ b/drivers/media/platform/davinci/vpif_display.c
> @@ -101,7 +101,7 @@ static int vpif_buffer_prepare(struct vb2_buffer *vb)
> * vpif_buffer_queue_setup : Callback function for buffer setup.

same (s/ : / - /)

> * @vq: vb2_queue ptr
> * @nbuffers: ptr to number of buffers requested by application
> - * @nplanes:: contains number of distinct video planes needed to hold a frame
> + * @nplanes: contains number of distinct video planes needed to hold a frame
> * @sizes: contains the size (in bytes) of each plane.
> * @alloc_devs: ptr to allocation context
> *
>

Thanks.
--
~Randy