[11/13] media: v4l2-async: Drop v4l2_fwnode_reference_parse_sensor_common mention

  The v4l2_async_notifier_cleanup documentation mentions
v4l2_fwnode_reference_parse_sensor_common, which doesn't exist.
Drop it.

Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
---
 include/media/v4l2-async.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
  

Hi Ezequiel,

Thank you for the patch.

On Tue, Jan 12, 2021 at 10:23:37AM -0300, Ezequiel Garcia wrote:
> The v4l2_async_notifier_cleanup documentation mentions
> v4l2_fwnode_reference_parse_sensor_common, which doesn't exist.
> Drop it.

The function is actually called
v4l2_async_notifier_parse_fwnode_sensor_common(). It was introduced in
commit 7a9ec808ad46 ("media: v4l: fwnode: Add convenience function for
parsing common external refs") with an incorrect name in the
documentation. Commit b064945517ee ("media: fix kernel-doc markups")
fixed the kerneldoc header for the function, but forgot to address this
location.

> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
> ---
>  include/media/v4l2-async.h | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/include/media/v4l2-async.h b/include/media/v4l2-async.h
> index 76be1e01222e..2429ac55be1c 100644
> --- a/include/media/v4l2-async.h
> +++ b/include/media/v4l2-async.h
> @@ -290,9 +290,8 @@ void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);
>   * sub-devices allocated for the purposes of the notifier but not the notifier
>   * itself. The user is responsible for calling this function to clean up the
>   * notifier after calling
> - * @v4l2_async_notifier_add_subdev,
> - * @v4l2_async_notifier_parse_fwnode_endpoints or
> - * @v4l2_fwnode_reference_parse_sensor_common.
> + * @v4l2_async_notifier_add_subdev or
> + * @v4l2_async_notifier_parse_fwnode_endpoints.
>   *
>   * There is no harm from calling v4l2_async_notifier_cleanup in other
>   * cases as long as its memory has been zeroed after it has been
  

On Thu, 2021-01-14 at 04:14 +0200, Laurent Pinchart wrote:
> Hi Ezequiel,
> 
> Thank you for the patch.
> 
> On Tue, Jan 12, 2021 at 10:23:37AM -0300, Ezequiel Garcia wrote:
> > The v4l2_async_notifier_cleanup documentation mentions
> > v4l2_fwnode_reference_parse_sensor_common, which doesn't exist.
> > Drop it.
> 
> The function is actually called
> v4l2_async_notifier_parse_fwnode_sensor_common(). It was introduced in
> commit 7a9ec808ad46 ("media: v4l: fwnode: Add convenience function for
> parsing common external refs") with an incorrect name in the
> documentation. Commit b064945517ee ("media: fix kernel-doc markups")
> fixed the kerneldoc header for the function, but forgot to address this
> location.
> 

OK, I'll fix the commit description.

Thanks,
Ezequiel
  

Hi Ezequiel,

On Thu, Jan 14, 2021 at 10:36:54AM -0300, Ezequiel Garcia wrote:
> On Thu, 2021-01-14 at 04:14 +0200, Laurent Pinchart wrote:
> > On Tue, Jan 12, 2021 at 10:23:37AM -0300, Ezequiel Garcia wrote:
> > > The v4l2_async_notifier_cleanup documentation mentions
> > > v4l2_fwnode_reference_parse_sensor_common, which doesn't exist.
> > > Drop it.
> > 
> > The function is actually called
> > v4l2_async_notifier_parse_fwnode_sensor_common(). It was introduced in
> > commit 7a9ec808ad46 ("media: v4l: fwnode: Add convenience function for
> > parsing common external refs") with an incorrect name in the
> > documentation. Commit b064945517ee ("media: fix kernel-doc markups")
> > fixed the kerneldoc header for the function, but forgot to address this
> > location.
> 
> OK, I'll fix the commit description.

I think it's more than the commit description, instead of dropping the
reference to v4l2_fwnode_reference_parse_sensor_common(), it should be
replaced with a reference to
v4l2_async_notifier_parse_fwnode_sensor_common().