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

Path	csiph.com!feeder.erje.net!1.us.feeder.erje.net!newsfeed.fsmpi.rwth-aachen.de!newsfeed.straub-nv.de!news.mixmin.net!aioe.org!gothmog.csi.it!bofh.it!news.nic.it!robomod
From	Sakari Ailus <sakari.ailus@iki.fi>
Newsgroups	linux.kernel
Subject	Re: [RESEND PATCH] [media] vb2: Fix vb2_core_dqbuf() kernel-doc
Date	Wed, 17 Aug 2016 11:10:01 +0200
Message-ID	<s751f-7ok-9@gated-at.bofh.it> (permalink)
References	<s6Nxo-4cZ-15@gated-at.bofh.it>
MIME-Version	1.0
Content-Type	text/plain; charset=us-ascii
Content-Disposition	inline
User-Agent	Mutt/1.5.23 (2014-03-12)
Sender	robomod@news.nic.it
List-ID	<linux-kernel.vger.kernel.org>
X-Mailing-List	linux-kernel@vger.kernel.org
Approved	robomod@news.nic.it
Lines	42
Organization	linux.* mail to news gateway
X-Original-Cc	linux-kernel@vger.kernel.org, Hans Verkuil <hverkuil@xs4all.nl>, Mauro Carvalho Chehab <mchehab@kernel.org>, Marek Szyprowski <m.szyprowski@samsung.com>, Kyungmin Park <kyungmin.park@samsung.com>, Pawel Osciak <pawel@osciak.com>, linux-media@vger.kernel.org
X-Original-Date	Wed, 17 Aug 2016 12:01:44 +0300
X-Original-Message-ID	<20160817090144.GD3182@valkosipuli.retiisi.org.uk>
X-Original-References	<1471357216-23230-1-git-send-email-javier@osg.samsung.com>
X-Original-Sender	linux-kernel-owner@vger.kernel.org
Xref	csiph.com linux.kernel:1464428

Show key headers only | View raw

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

Thread

[RESEND PATCH] [media] vb2: Fix vb2_core_dqbuf() kernel-doc Javier Martinez Canillas <javier@osg.samsung.com> - 2016-08-16 16:30 +0200
  Re: [RESEND PATCH] [media] vb2: Fix vb2_core_dqbuf() kernel-doc Sakari Ailus <sakari.ailus@iki.fi> - 2016-08-17 11:10 +0200
    Re: [RESEND PATCH] [media] vb2: Fix vb2_core_dqbuf() kernel-doc Javier Martinez Canillas <javier@osg.samsung.com> - 2016-08-17 19:30 +0200

csiph-web