diff mbox series

[v2,2/3] media: Documentation: BT.601 is not a bus

Message ID 20231017105630.558089-3-sakari.ailus@linux.intel.com (mailing list archive)
State New, archived
Headers show
Series Document link-frequencies better, small fixes | expand

Commit Message

Sakari Ailus Oct. 17, 2023, 10:56 a.m. UTC
BT.601 is not actually a bus specification, leaving parallel bus without a
specification to refer to. Fix this.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 Documentation/driver-api/media/camera-sensor.rst | 4 ++--
 Documentation/driver-api/media/tx-rx.rst         | 3 +--
 2 files changed, 3 insertions(+), 4 deletions(-)

Comments

Laurent Pinchart Oct. 17, 2023, 11:38 a.m. UTC | #1
Hi Sakari,

Thank you for the patch.

On Tue, Oct 17, 2023 at 01:56:29PM +0300, Sakari Ailus wrote:
> BT.601 is not actually a bus specification, leaving parallel bus without a
> specification to refer to. Fix this.

I'm really annoyed there's no standard name for parallel buses :-(

> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> ---
>  Documentation/driver-api/media/camera-sensor.rst | 4 ++--
>  Documentation/driver-api/media/tx-rx.rst         | 3 +--
>  2 files changed, 3 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/driver-api/media/camera-sensor.rst b/Documentation/driver-api/media/camera-sensor.rst
> index 0de5c86cbd1f..19f2feeecc91 100644
> --- a/Documentation/driver-api/media/camera-sensor.rst
> +++ b/Documentation/driver-api/media/camera-sensor.rst
> @@ -9,8 +9,8 @@ This document covers the in-kernel APIs only. For the best practices on
>  userspace API implementation in camera sensor drivers, please see
>  :ref:`media_using_camera_sensor_drivers`.
>  
> -CSI-2 and parallel (BT.601 and BT.656) busses
> ----------------------------------------------
> +CSI-2 and parallel and BT.656 buses

CSI-2, parallel and BT.656 buses

> +-----------------------------------
>  
>  Please see :ref:`transmitter-receiver`.
>  
> diff --git a/Documentation/driver-api/media/tx-rx.rst b/Documentation/driver-api/media/tx-rx.rst
> index e1e9258dd862..7e115e3c4735 100644
> --- a/Documentation/driver-api/media/tx-rx.rst
> +++ b/Documentation/driver-api/media/tx-rx.rst
> @@ -25,9 +25,8 @@ the host SoC. It is defined by the `MIPI alliance`_.
>  Parallel
>  ^^^^^^^^
>  
> -`BT.601`_ and `BT.656`_ are the most common parallel busses.
> +The parallel bus and its `BT.656`_ variant are the most common parallel busses.

We use "parallel" to mean explicit sync signals in many places
(including APIs), and here it covers BT.656 too :-( This sentence is
fairly bad.

>  
> -.. _`BT.601`: https://en.wikipedia.org/wiki/Rec._601
>  .. _`BT.656`: https://en.wikipedia.org/wiki/ITU-R_BT.656
>  
>  Transmitter drivers
Sakari Ailus Oct. 18, 2023, 11:20 a.m. UTC | #2
Hi Laurent,

Thanks for the review.

On Tue, Oct 17, 2023 at 02:38:53PM +0300, Laurent Pinchart wrote:
> Hi Sakari,
> 
> Thank you for the patch.
> 
> On Tue, Oct 17, 2023 at 01:56:29PM +0300, Sakari Ailus wrote:
> > BT.601 is not actually a bus specification, leaving parallel bus without a
> > specification to refer to. Fix this.
> 
> I'm really annoyed there's no standard name for parallel buses :-(
> 
> > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > ---
> >  Documentation/driver-api/media/camera-sensor.rst | 4 ++--
> >  Documentation/driver-api/media/tx-rx.rst         | 3 +--
> >  2 files changed, 3 insertions(+), 4 deletions(-)
> > 
> > diff --git a/Documentation/driver-api/media/camera-sensor.rst b/Documentation/driver-api/media/camera-sensor.rst
> > index 0de5c86cbd1f..19f2feeecc91 100644
> > --- a/Documentation/driver-api/media/camera-sensor.rst
> > +++ b/Documentation/driver-api/media/camera-sensor.rst
> > @@ -9,8 +9,8 @@ This document covers the in-kernel APIs only. For the best practices on
> >  userspace API implementation in camera sensor drivers, please see
> >  :ref:`media_using_camera_sensor_drivers`.
> >  
> > -CSI-2 and parallel (BT.601 and BT.656) busses
> > ----------------------------------------------
> > +CSI-2 and parallel and BT.656 buses
> 
> CSI-2, parallel and BT.656 buses

Yes.

> 
> > +-----------------------------------
> >  
> >  Please see :ref:`transmitter-receiver`.
> >  
> > diff --git a/Documentation/driver-api/media/tx-rx.rst b/Documentation/driver-api/media/tx-rx.rst
> > index e1e9258dd862..7e115e3c4735 100644
> > --- a/Documentation/driver-api/media/tx-rx.rst
> > +++ b/Documentation/driver-api/media/tx-rx.rst
> > @@ -25,9 +25,8 @@ the host SoC. It is defined by the `MIPI alliance`_.
> >  Parallel
> >  ^^^^^^^^
> >  
> > -`BT.601`_ and `BT.656`_ are the most common parallel busses.
> > +The parallel bus and its `BT.656`_ variant are the most common parallel busses.
> 
> We use "parallel" to mean explicit sync signals in many places
> (including APIs), and here it covers BT.656 too :-( This sentence is
> fairly bad.

I'll mention parallel and BT.656 separately.

> 
> >  
> > -.. _`BT.601`: https://en.wikipedia.org/wiki/Rec._601
> >  .. _`BT.656`: https://en.wikipedia.org/wiki/ITU-R_BT.656
> >  
> >  Transmitter drivers
>
diff mbox series

Patch

diff --git a/Documentation/driver-api/media/camera-sensor.rst b/Documentation/driver-api/media/camera-sensor.rst
index 0de5c86cbd1f..19f2feeecc91 100644
--- a/Documentation/driver-api/media/camera-sensor.rst
+++ b/Documentation/driver-api/media/camera-sensor.rst
@@ -9,8 +9,8 @@  This document covers the in-kernel APIs only. For the best practices on
 userspace API implementation in camera sensor drivers, please see
 :ref:`media_using_camera_sensor_drivers`.
 
-CSI-2 and parallel (BT.601 and BT.656) busses
----------------------------------------------
+CSI-2 and parallel and BT.656 buses
+-----------------------------------
 
 Please see :ref:`transmitter-receiver`.
 
diff --git a/Documentation/driver-api/media/tx-rx.rst b/Documentation/driver-api/media/tx-rx.rst
index e1e9258dd862..7e115e3c4735 100644
--- a/Documentation/driver-api/media/tx-rx.rst
+++ b/Documentation/driver-api/media/tx-rx.rst
@@ -25,9 +25,8 @@  the host SoC. It is defined by the `MIPI alliance`_.
 Parallel
 ^^^^^^^^
 
-`BT.601`_ and `BT.656`_ are the most common parallel busses.
+The parallel bus and its `BT.656`_ variant are the most common parallel busses.
 
-.. _`BT.601`: https://en.wikipedia.org/wiki/Rec._601
 .. _`BT.656`: https://en.wikipedia.org/wiki/ITU-R_BT.656
 
 Transmitter drivers