[1/2] media: v4l2-subdev: Fix documentation of the subdev_notifier member

Message ID 20210609115457.822085-1-paul.kocialkowski@bootlin.com (mailing list archive)
State Under Review, archived
Delegated to: Sakari Ailus
Headers
Series [1/2] media: v4l2-subdev: Fix documentation of the subdev_notifier member |

Commit Message

Paul Kocialkowski June 9, 2021, 11:54 a.m. UTC
  Fix the name of the function that registers the subdev_notifier member
of the v4l2_subdev structure.

Signed-off-by: Paul Kocialkowski <paul.kocialkowski@bootlin.com>
---
 include/media/v4l2-subdev.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Sakari Ailus June 9, 2021, 12:30 p.m. UTC | #1
Hi Paul,

On Wed, Jun 09, 2021 at 01:54:56PM +0200, Paul Kocialkowski wrote:
> Fix the name of the function that registers the subdev_notifier member
> of the v4l2_subdev structure.
> 
> Signed-off-by: Paul Kocialkowski <paul.kocialkowski@bootlin.com>
> ---
>  include/media/v4l2-subdev.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
> index d0e9a5bdb08b..f3b657dfe304 100644
> --- a/include/media/v4l2-subdev.h
> +++ b/include/media/v4l2-subdev.h
> @@ -854,7 +854,7 @@ struct v4l2_subdev_platform_data {
>   * @asd: Pointer to respective &struct v4l2_async_subdev.
>   * @notifier: Pointer to the managing notifier.
>   * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
> - *		     device using v4l2_device_register_sensor_subdev().
> + *		     device using v4l2_async_register_subdev_sensor_common().

I agree in principle, but the function is nowadays called
v4l2_async_register_subdev_sensor().

I can fix this while applying.
  
Paul Kocialkowski June 9, 2021, 1:03 p.m. UTC | #2
Hi Sakari,

On Wed 09 Jun 21, 15:30, Sakari Ailus wrote:
> Hi Paul,
> 
> On Wed, Jun 09, 2021 at 01:54:56PM +0200, Paul Kocialkowski wrote:
> > Fix the name of the function that registers the subdev_notifier member
> > of the v4l2_subdev structure.
> > 
> > Signed-off-by: Paul Kocialkowski <paul.kocialkowski@bootlin.com>
> > ---
> >  include/media/v4l2-subdev.h | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
> > index d0e9a5bdb08b..f3b657dfe304 100644
> > --- a/include/media/v4l2-subdev.h
> > +++ b/include/media/v4l2-subdev.h
> > @@ -854,7 +854,7 @@ struct v4l2_subdev_platform_data {
> >   * @asd: Pointer to respective &struct v4l2_async_subdev.
> >   * @notifier: Pointer to the managing notifier.
> >   * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
> > - *		     device using v4l2_device_register_sensor_subdev().
> > + *		     device using v4l2_async_register_subdev_sensor_common().
> 
> I agree in principle, but the function is nowadays called
> v4l2_async_register_subdev_sensor().
> 
> I can fix this while applying.

Looks like I missed the rename when rebasing my patch on media/master!
Of course, feel free to update with the new name.

Thanks,

Paul
  

Patch

diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
index d0e9a5bdb08b..f3b657dfe304 100644
--- a/include/media/v4l2-subdev.h
+++ b/include/media/v4l2-subdev.h
@@ -854,7 +854,7 @@  struct v4l2_subdev_platform_data {
  * @asd: Pointer to respective &struct v4l2_async_subdev.
  * @notifier: Pointer to the managing notifier.
  * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
- *		     device using v4l2_device_register_sensor_subdev().
+ *		     device using v4l2_async_register_subdev_sensor_common().
  * @pdata: common part of subdevice platform data
  *
  * Each instance of a subdev driver should create this struct, either