diff mbox series

[v2,11/14] media: v4l2-async: Fix incorrect comment

Message ID 20210118015258.3993-12-ezequiel@collabora.com
State Superseded
Headers show
Series [v2,01/14] media: v4l2-async: Clean v4l2_async_notifier_add_fwnode_remote_subdev | expand

Commit Message

Ezequiel Garcia Jan. 18, 2021, 1:52 a.m. UTC
The v4l2_async_notifier_cleanup() documentation mentions
v4l2_fwnode_reference_parse_sensor_common, which was actually
introduced as v4l2_async_notifier_parse_fwnode_sensor_common(),
in commit 7a9ec808ad46 ("media: v4l: fwnode: Add convenience function for
parsing common external refs").

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

Comments

Helen Mae Koike Fornazier Jan. 19, 2021, 6:54 p.m. UTC | #1
Hi Ezequiel,

On 1/17/21 10:52 PM, Ezequiel Garcia wrote:
> The v4l2_async_notifier_cleanup() documentation mentions

> v4l2_fwnode_reference_parse_sensor_common, which was actually

> introduced as v4l2_async_notifier_parse_fwnode_sensor_common(),

> in commit 7a9ec808ad46 ("media: v4l: fwnode: Add convenience function for

> parsing common external refs").

> 

> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>> ---

>  include/media/v4l2-async.h | 2 +-

>  1 file changed, 1 insertion(+), 1 deletion(-)

> 

> diff --git a/include/media/v4l2-async.h b/include/media/v4l2-async.h

> index 55bfb27e404e..2144502c95e0 100644

> --- a/include/media/v4l2-async.h

> +++ b/include/media/v4l2-async.h

> @@ -242,7 +242,7 @@ void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);

>   * notifier after calling

>   * @v4l2_async_notifier_add_subdev,

>   * @v4l2_async_notifier_parse_fwnode_endpoints or

> - * @v4l2_fwnode_reference_parse_sensor_common.

> + * @v4l2_async_notifier_parse_fwnode_sensor_common.


I see that this function is only used in the framework by v4l2_async_register_subdev_sensor_common()

Shouldn't we change v4l2_async_notifier_parse_fwnode_sensor_common() to static
and remove it from this comment?

Regards,
Helen

>   *

>   * 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

>
Ezequiel Garcia Jan. 19, 2021, 8:12 p.m. UTC | #2
On Tue, 2021-01-19 at 15:54 -0300, Helen Koike wrote:
> Hi Ezequiel,

> 

> On 1/17/21 10:52 PM, Ezequiel Garcia wrote:

> > The v4l2_async_notifier_cleanup() documentation mentions

> > v4l2_fwnode_reference_parse_sensor_common, which was actually

> > introduced as v4l2_async_notifier_parse_fwnode_sensor_common(),

> > in commit 7a9ec808ad46 ("media: v4l: fwnode: Add convenience function for

> > parsing common external refs").

> > 

> > Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>> ---

> >  include/media/v4l2-async.h | 2 +-

> >  1 file changed, 1 insertion(+), 1 deletion(-)

> > 

> > diff --git a/include/media/v4l2-async.h b/include/media/v4l2-async.h

> > index 55bfb27e404e..2144502c95e0 100644

> > --- a/include/media/v4l2-async.h

> > +++ b/include/media/v4l2-async.h

> > @@ -242,7 +242,7 @@ void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);

> >   * notifier after calling

> >   * @v4l2_async_notifier_add_subdev,

> >   * @v4l2_async_notifier_parse_fwnode_endpoints or

> > - * @v4l2_fwnode_reference_parse_sensor_common.

> > + * @v4l2_async_notifier_parse_fwnode_sensor_common.

> 

> I see that this function is only used in the framework by v4l2_async_register_subdev_sensor_common()

> 

> Shouldn't we change v4l2_async_notifier_parse_fwnode_sensor_common() to static

> and remove it from this comment?

> 


I haven't noticed that, but it makes sense indeed.

Sakari, what do you think?

Thanks,
Ezequiel
Sakari Ailus Jan. 21, 2021, 10:55 a.m. UTC | #3
Hi Ezequiel,

On Tue, Jan 19, 2021 at 05:12:23PM -0300, Ezequiel Garcia wrote:
> On Tue, 2021-01-19 at 15:54 -0300, Helen Koike wrote:

> > Hi Ezequiel,

> > 

> > On 1/17/21 10:52 PM, Ezequiel Garcia wrote:

> > > The v4l2_async_notifier_cleanup() documentation mentions

> > > v4l2_fwnode_reference_parse_sensor_common, which was actually

> > > introduced as v4l2_async_notifier_parse_fwnode_sensor_common(),

> > > in commit 7a9ec808ad46 ("media: v4l: fwnode: Add convenience function for

> > > parsing common external refs").

> > > 

> > > Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>> ---

> > >  include/media/v4l2-async.h | 2 +-

> > >  1 file changed, 1 insertion(+), 1 deletion(-)

> > > 

> > > diff --git a/include/media/v4l2-async.h b/include/media/v4l2-async.h

> > > index 55bfb27e404e..2144502c95e0 100644

> > > --- a/include/media/v4l2-async.h

> > > +++ b/include/media/v4l2-async.h

> > > @@ -242,7 +242,7 @@ void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);

> > >   * notifier after calling

> > >   * @v4l2_async_notifier_add_subdev,

> > >   * @v4l2_async_notifier_parse_fwnode_endpoints or

> > > - * @v4l2_fwnode_reference_parse_sensor_common.

> > > + * @v4l2_async_notifier_parse_fwnode_sensor_common.

> > 

> > I see that this function is only used in the framework by v4l2_async_register_subdev_sensor_common()

> > 

> > Shouldn't we change v4l2_async_notifier_parse_fwnode_sensor_common() to static

> > and remove it from this comment?

> > 

> 

> I haven't noticed that, but it makes sense indeed.

> 

> Sakari, what do you think?


I have no objections. Could you just move the kerneldoc documentation to
the .c file while you make the function static?

-- 
Regards,

Sakari Ailus
diff mbox series

Patch

diff --git a/include/media/v4l2-async.h b/include/media/v4l2-async.h
index 55bfb27e404e..2144502c95e0 100644
--- a/include/media/v4l2-async.h
+++ b/include/media/v4l2-async.h
@@ -242,7 +242,7 @@  void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);
  * notifier after calling
  * @v4l2_async_notifier_add_subdev,
  * @v4l2_async_notifier_parse_fwnode_endpoints or
- * @v4l2_fwnode_reference_parse_sensor_common.
+ * @v4l2_async_notifier_parse_fwnode_sensor_common.
  *
  * 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