[RESEND PATCH] [media] vb2: Fix vb2_core_dqbuf() kernel-doc

[RESEND PATCH] [media] vb2: Fix vb2_core_dqbuf() kernel-doc

[Javier Martinez Canillas]

The kernel-doc has the wrong function name and also the pindex
parameter is missing in the documentation.

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>

---

This patch was posted some weeks ago but I noticed that wasn't
picked by patchwork, so I'm resend it.

 drivers/media/v4l2-core/videobuf2-core.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/media/v4l2-core/videobuf2-core.c b/drivers/media/v4l2-core/videobuf2-core.c
index ca8ffeb56d72..1dbd7beb71f0 100644
--- a/drivers/media/v4l2-core/videobuf2-core.c
+++ b/drivers/media/v4l2-core/videobuf2-core.c
@@ -1726,8 +1726,9 @@ static void __vb2_dqbuf(struct vb2_buffer *vb)
 }
 
 /**
- * vb2_dqbuf() - Dequeue a buffer to the userspace
+ * vb2_core_dqbuf() - Dequeue a buffer to the userspace
  * @q:		videobuf2 queue
+ * @pindex:	id number of the buffer
  * @pb:		buffer structure passed from userspace to vidioc_dqbuf handler
  *		in driver
  * @nonblocking: if true, this call will not sleep waiting for a buffer if no
-- 
2.5.5

Re: [RESEND PATCH] [media] vb2: Fix vb2_core_dqbuf() kernel-doc

[Sakari Ailus]

Hi Javier,

On Tue, Aug 16, 2016 at 10:20:16AM -0400, Javier Martinez Canillas wrote:
> The kernel-doc has the wrong function name and also the pindex
> parameter is missing in the documentation.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> 
> ---
> 
> This patch was posted some weeks ago but I noticed that wasn't
> picked by patchwork, so I'm resend it.
> 
>  drivers/media/v4l2-core/videobuf2-core.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/media/v4l2-core/videobuf2-core.c b/drivers/media/v4l2-core/videobuf2-core.c
> index ca8ffeb56d72..1dbd7beb71f0 100644
> --- a/drivers/media/v4l2-core/videobuf2-core.c
> +++ b/drivers/media/v4l2-core/videobuf2-core.c
> @@ -1726,8 +1726,9 @@ static void __vb2_dqbuf(struct vb2_buffer *vb)
>  }
>  
>  /**
> - * vb2_dqbuf() - Dequeue a buffer to the userspace
> + * vb2_core_dqbuf() - Dequeue a buffer to the userspace
>   * @q:		videobuf2 queue
> + * @pindex:	id number of the buffer

How about: "Pointer to the buffer index. May be NULL.".

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>

>   * @pb:		buffer structure passed from userspace to vidioc_dqbuf handler
>   *		in driver
>   * @nonblocking: if true, this call will not sleep waiting for a buffer if no

-- 
Cheers,

Sakari Ailus
e-mail: sakari.ailus@iki.fi	XMPP: sailus@retiisi.org.uk

Re: [RESEND PATCH] [media] vb2: Fix vb2_core_dqbuf() kernel-doc

[Javier Martinez Canillas]

Hello Sakari,

On 08/17/2016 05:01 AM, Sakari Ailus wrote:
> Hi Javier,
> 
> On Tue, Aug 16, 2016 at 10:20:16AM -0400, Javier Martinez Canillas wrote:
>> The kernel-doc has the wrong function name and also the pindex
>> parameter is missing in the documentation.
>>
>> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
>>
>> ---
>>
>> This patch was posted some weeks ago but I noticed that wasn't
>> picked by patchwork, so I'm resend it.
>>
>>  drivers/media/v4l2-core/videobuf2-core.c | 3 ++-
>>  1 file changed, 2 insertions(+), 1 deletion(-)
>>
>> diff --git a/drivers/media/v4l2-core/videobuf2-core.c b/drivers/media/v4l2-core/videobuf2-core.c
>> index ca8ffeb56d72..1dbd7beb71f0 100644
>> --- a/drivers/media/v4l2-core/videobuf2-core.c
>> +++ b/drivers/media/v4l2-core/videobuf2-core.c
>> @@ -1726,8 +1726,9 @@ static void __vb2_dqbuf(struct vb2_buffer *vb)
>>  }
>>  
>>  /**
>> - * vb2_dqbuf() - Dequeue a buffer to the userspace
>> + * vb2_core_dqbuf() - Dequeue a buffer to the userspace
>>   * @q:		videobuf2 queue
>> + * @pindex:	id number of the buffer
> 
> How about: "Pointer to the buffer index. May be NULL.".
>

Sure, I'll change it.
 
> Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
>

Thanks.

Best regards,
-- 
Javier Martinez Canillas
Open Source Group
Samsung Research America