diff mbox series

[RFC,2/4] media: Documentation: Reword split of sensor driver to two classes

Message ID 20241011075535.588140-3-sakari.ailus@linux.intel.com
State New
Headers show
Series Sub-device configuration models | expand

Commit Message

Sakari Ailus Oct. 11, 2024, 7:55 a.m. UTC
The sensor drivers do not configure the output size of the sensors but the
entire internal pipeline. Reflect this in the documentation.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 .../userspace-api/media/drivers/camera-sensor.rst      | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

Comments

Laurent Pinchart Oct. 22, 2024, 7:39 p.m. UTC | #1
On Tue, Oct 22, 2024 at 05:12:58PM +0200, Jacopo Mondi wrote:
> On Fri, Oct 11, 2024 at 10:55:33AM +0300, Sakari Ailus wrote:
> > The sensor drivers do not configure the output size of the sensors but the
> > entire internal pipeline. Reflect this in the documentation.
> >
> > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > ---
> >  .../userspace-api/media/drivers/camera-sensor.rst      | 10 ++++++----
> >  1 file changed, 6 insertions(+), 4 deletions(-)
> >
> > diff --git a/Documentation/userspace-api/media/drivers/camera-sensor.rst b/Documentation/userspace-api/media/drivers/camera-sensor.rst
> > index d82cd803e337..ad4049ff7eec 100644
> > --- a/Documentation/userspace-api/media/drivers/camera-sensor.rst
> > +++ b/Documentation/userspace-api/media/drivers/camera-sensor.rst
> > @@ -10,11 +10,13 @@ used to control the camera sensor drivers.
> >
> >  You may also find :ref:`media_writing_camera_sensor_drivers` useful.
> >
> > -Frame size
> > -----------
> > +Sensor internal pipeline configuration
> > +--------------------------------------
> >
> > -There are two distinct ways to configure the frame size produced by camera
> > -sensors.
> > +The camera sensors have an internal processing pipeline including cropping and
> 
> As a non native speaker I'm probably wrong, but "The" followed by a plural
> name to identify a category sounds weird to me.
> 
> What about just
> "Camera sensors have"

That's better, yes.

> > +binning functionality. The sensor drivers belong to two distinct classes, freely
> 
> functionalities ?

"functionality" is uncountable when it means "The ability to do a task,
performance, or execution; a set of functions that something is able or
equipped to perform".

> Same question for "The sensor drivers", just "Sensor drivers" ?
>
> > +configurable and register list based drivers, depending on how the driver

s/ based/-based/

> 
> s/drivers/ones ?

The English language is less concerned about repetitions than French,
and I assume also Italian. "[...] and register list-based ones" sound
less natural to me.

> > +configures this functionality.
> 
> configures the pipeline.

Ack on this change.

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

> ?
> 
> >
> >  Freely configurable camera sensor drivers
> >  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sakari Ailus Nov. 8, 2024, 12:39 p.m. UTC | #2
Hi Laurent, Jacopo,

On Tue, Oct 22, 2024 at 10:39:58PM +0300, Laurent Pinchart wrote:
> On Tue, Oct 22, 2024 at 05:12:58PM +0200, Jacopo Mondi wrote:
> > On Fri, Oct 11, 2024 at 10:55:33AM +0300, Sakari Ailus wrote:
> > > The sensor drivers do not configure the output size of the sensors but the
> > > entire internal pipeline. Reflect this in the documentation.
> > >
> > > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > > ---
> > >  .../userspace-api/media/drivers/camera-sensor.rst      | 10 ++++++----
> > >  1 file changed, 6 insertions(+), 4 deletions(-)
> > >
> > > diff --git a/Documentation/userspace-api/media/drivers/camera-sensor.rst b/Documentation/userspace-api/media/drivers/camera-sensor.rst
> > > index d82cd803e337..ad4049ff7eec 100644
> > > --- a/Documentation/userspace-api/media/drivers/camera-sensor.rst
> > > +++ b/Documentation/userspace-api/media/drivers/camera-sensor.rst
> > > @@ -10,11 +10,13 @@ used to control the camera sensor drivers.
> > >
> > >  You may also find :ref:`media_writing_camera_sensor_drivers` useful.
> > >
> > > -Frame size
> > > -----------
> > > +Sensor internal pipeline configuration
> > > +--------------------------------------
> > >
> > > -There are two distinct ways to configure the frame size produced by camera
> > > -sensors.
> > > +The camera sensors have an internal processing pipeline including cropping and
> > 
> > As a non native speaker I'm probably wrong, but "The" followed by a plural
> > name to identify a category sounds weird to me.
> > 
> > What about just
> > "Camera sensors have"
> 
> That's better, yes.

Agreed.

> 
> > > +binning functionality. The sensor drivers belong to two distinct classes, freely
> > 
> > functionalities ?
> 
> "functionality" is uncountable when it means "The ability to do a task,
> performance, or execution; a set of functions that something is able or
> equipped to perform".
> 
> > Same question for "The sensor drivers", just "Sensor drivers" ?
> >
> > > +configurable and register list based drivers, depending on how the driver
> 
> s/ based/-based/

There are about four other instances of this, I can change those too...

> 
> > 
> > s/drivers/ones ?
> 
> The English language is less concerned about repetitions than French,
> and I assume also Italian. "[...] and register list-based ones" sound
> less natural to me.

Yes, yes, yes, yes.

> 
> > > +configures this functionality.
> > 
> > configures the pipeline.
> 
> Ack on this change.
> 
> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Thanks!
Laurent Pinchart Nov. 8, 2024, 12:57 p.m. UTC | #3
On Fri, Nov 08, 2024 at 12:39:28PM +0000, Sakari Ailus wrote:
> Hi Laurent, Jacopo,
> 
> On Tue, Oct 22, 2024 at 10:39:58PM +0300, Laurent Pinchart wrote:
> > On Tue, Oct 22, 2024 at 05:12:58PM +0200, Jacopo Mondi wrote:
> > > On Fri, Oct 11, 2024 at 10:55:33AM +0300, Sakari Ailus wrote:
> > > > The sensor drivers do not configure the output size of the sensors but the
> > > > entire internal pipeline. Reflect this in the documentation.
> > > >
> > > > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > > > ---
> > > >  .../userspace-api/media/drivers/camera-sensor.rst      | 10 ++++++----
> > > >  1 file changed, 6 insertions(+), 4 deletions(-)
> > > >
> > > > diff --git a/Documentation/userspace-api/media/drivers/camera-sensor.rst b/Documentation/userspace-api/media/drivers/camera-sensor.rst
> > > > index d82cd803e337..ad4049ff7eec 100644
> > > > --- a/Documentation/userspace-api/media/drivers/camera-sensor.rst
> > > > +++ b/Documentation/userspace-api/media/drivers/camera-sensor.rst
> > > > @@ -10,11 +10,13 @@ used to control the camera sensor drivers.
> > > >
> > > >  You may also find :ref:`media_writing_camera_sensor_drivers` useful.
> > > >
> > > > -Frame size
> > > > -----------
> > > > +Sensor internal pipeline configuration
> > > > +--------------------------------------
> > > >
> > > > -There are two distinct ways to configure the frame size produced by camera
> > > > -sensors.
> > > > +The camera sensors have an internal processing pipeline including cropping and
> > > 
> > > As a non native speaker I'm probably wrong, but "The" followed by a plural
> > > name to identify a category sounds weird to me.
> > > 
> > > What about just
> > > "Camera sensors have"
> > 
> > That's better, yes.
> 
> Agreed.
> 
> > 
> > > > +binning functionality. The sensor drivers belong to two distinct classes, freely
> > > 
> > > functionalities ?
> > 
> > "functionality" is uncountable when it means "The ability to do a task,
> > performance, or execution; a set of functions that something is able or
> > equipped to perform".
> > 
> > > Same question for "The sensor drivers", just "Sensor drivers" ?
> > >
> > > > +configurable and register list based drivers, depending on how the driver
> > 
> > s/ based/-based/
> 
> There are about four other instances of this, I can change those too...

https://english.stackexchange.com/questions/65630/you-should-be-well-organised-or-you-should-be-well-organised

Those are register list-based drivers. Those drivers are register list
based.

> > > 
> > > s/drivers/ones ?
> > 
> > The English language is less concerned about repetitions than French,
> > and I assume also Italian. "[...] and register list-based ones" sound
> > less natural to me.
> 
> Yes, yes, yes, yes.
> 
> > > > +configures this functionality.
> > > 
> > > configures the pipeline.
> > 
> > Ack on this change.
> > 
> > Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> 
> Thanks!
diff mbox series

Patch

diff --git a/Documentation/userspace-api/media/drivers/camera-sensor.rst b/Documentation/userspace-api/media/drivers/camera-sensor.rst
index d82cd803e337..ad4049ff7eec 100644
--- a/Documentation/userspace-api/media/drivers/camera-sensor.rst
+++ b/Documentation/userspace-api/media/drivers/camera-sensor.rst
@@ -10,11 +10,13 @@  used to control the camera sensor drivers.
 
 You may also find :ref:`media_writing_camera_sensor_drivers` useful.
 
-Frame size
-----------
+Sensor internal pipeline configuration
+--------------------------------------
 
-There are two distinct ways to configure the frame size produced by camera
-sensors.
+The camera sensors have an internal processing pipeline including cropping and
+binning functionality. The sensor drivers belong to two distinct classes, freely
+configurable and register list based drivers, depending on how the driver
+configures this functionality.
 
 Freely configurable camera sensor drivers
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~