diff mbox series

[RESEND,v3,02/32] media: Documentation: v4l: Document missing async subdev function

Message ID 20230525091615.2324824-3-sakari.ailus@linux.intel.com
State New
Headers show
Series Separate links and async sub-devices | expand

Commit Message

Sakari Ailus May 25, 2023, 9:15 a.m. UTC
Also v4l2_async_nf_add_fwnode() may be used to add an async sub-device
descriptor to a notifier. Document this.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 Documentation/driver-api/media/v4l2-subdev.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Laurent Pinchart May 30, 2023, 2:14 a.m. UTC | #1
Hi Sakari,

Thank you for the patch.

On Thu, May 25, 2023 at 12:15:45PM +0300, Sakari Ailus wrote:
> Also v4l2_async_nf_add_fwnode() may be used to add an async sub-device
> descriptor to a notifier. Document this.
> 
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> ---
>  Documentation/driver-api/media/v4l2-subdev.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
> index 602dadaa81d86..ce8e9d0a332bc 100644
> --- a/Documentation/driver-api/media/v4l2-subdev.rst
> +++ b/Documentation/driver-api/media/v4l2-subdev.rst
> @@ -204,9 +204,9 @@ that the bridge device needs for its operation. Several functions are available
>  to add subdevice descriptors to a notifier, depending on the type of device and
>  the needs of the driver.
>  
> -:c:func:`v4l2_async_nf_add_fwnode_remote` and
> -:c:func:`v4l2_async_nf_add_i2c` are for bridge and ISP drivers for
> -registering their async sub-devices with the notifier.
> +:c:func:`v4l2_async_nf_add_fwnode`, :c:func:`v4l2_async_nf_add_fwnode_remote`
> +:c:and func:`v4l2_async_nf_add_i2c` are for registering their async sub-devices

The 'and' isn't in the right place. With this fixed,

Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>

> +:c:with the notifier.
>  
>  :c:func:`v4l2_async_register_subdev_sensor` is a helper function for
>  sensor drivers registering their own async sub-device, but it also registers a
Sakari Ailus June 13, 2023, 1:43 p.m. UTC | #2
Hi Laurent,

On Tue, May 30, 2023 at 05:14:43AM +0300, Laurent Pinchart wrote:
> Hi Sakari,
> 
> Thank you for the patch.
> 
> On Thu, May 25, 2023 at 12:15:45PM +0300, Sakari Ailus wrote:
> > Also v4l2_async_nf_add_fwnode() may be used to add an async sub-device
> > descriptor to a notifier. Document this.
> > 
> > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > ---
> >  Documentation/driver-api/media/v4l2-subdev.rst | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> > 
> > diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
> > index 602dadaa81d86..ce8e9d0a332bc 100644
> > --- a/Documentation/driver-api/media/v4l2-subdev.rst
> > +++ b/Documentation/driver-api/media/v4l2-subdev.rst
> > @@ -204,9 +204,9 @@ that the bridge device needs for its operation. Several functions are available
> >  to add subdevice descriptors to a notifier, depending on the type of device and
> >  the needs of the driver.
> >  
> > -:c:func:`v4l2_async_nf_add_fwnode_remote` and
> > -:c:func:`v4l2_async_nf_add_i2c` are for bridge and ISP drivers for
> > -registering their async sub-devices with the notifier.
> > +:c:func:`v4l2_async_nf_add_fwnode`, :c:func:`v4l2_async_nf_add_fwnode_remote`
> > +:c:and func:`v4l2_async_nf_add_i2c` are for registering their async sub-devices
> 
> The 'and' isn't in the right place. With this fixed,
> 
> Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>

Thanks. Same below. Joe's word wrap sometimes does little tricks...

> > +:c:with the notifier.
> >  
> >  :c:func:`v4l2_async_register_subdev_sensor` is a helper function for
> >  sensor drivers registering their own async sub-device, but it also registers a
diff mbox series

Patch

diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
index 602dadaa81d86..ce8e9d0a332bc 100644
--- a/Documentation/driver-api/media/v4l2-subdev.rst
+++ b/Documentation/driver-api/media/v4l2-subdev.rst
@@ -204,9 +204,9 @@  that the bridge device needs for its operation. Several functions are available
 to add subdevice descriptors to a notifier, depending on the type of device and
 the needs of the driver.
 
-:c:func:`v4l2_async_nf_add_fwnode_remote` and
-:c:func:`v4l2_async_nf_add_i2c` are for bridge and ISP drivers for
-registering their async sub-devices with the notifier.
+:c:func:`v4l2_async_nf_add_fwnode`, :c:func:`v4l2_async_nf_add_fwnode_remote`
+:c:and func:`v4l2_async_nf_add_i2c` are for registering their async sub-devices
+:c:with the notifier.
 
 :c:func:`v4l2_async_register_subdev_sensor` is a helper function for
 sensor drivers registering their own async sub-device, but it also registers a