[PATCH] media: dt-bindings: renesas,rzg2l-cru: Improve documentation

[PATCH] media: dt-bindings: renesas,rzg2l-cru: Improve documentation

[Biju Das]

Fix the documentation issues pointed by Pavel while backporting
it to 6.1.y-cip.
 - Replace 'input'->'inputs' in main description
 - Replace 'Main'->'main' in CRU main clock description
 - Replace 'Register'-> 'register' in CRU Register access clock
   description

Reported-by: Pavel Machek <pavel@denx.de>
Closes: https://lore.kernel.org/all/ZtWJqOdRxkBkUb9y@duo.ucw.cz/
Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
---
 .../devicetree/bindings/media/renesas,rzg2l-cru.yaml        | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml b/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
index bc1245127025..d3c74341febc 100644
--- a/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
+++ b/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
@@ -13,7 +13,7 @@ maintainers:
 description:
   The CRU image processing module is a data conversion module equipped with pixel
   color space conversion, LUT, pixel format conversion, etc. An MIPI CSI-2 input and
-  parallel (including ITU-R BT.656) input are provided as the image sensor interface.
+  parallel (including ITU-R BT.656) inputs are provided as the image sensor interface.
 
 properties:
   compatible:
@@ -38,8 +38,8 @@ properties:
 
   clocks:
     items:
-      - description: CRU Main clock
-      - description: CRU Register access clock
+      - description: CRU main clock
+      - description: CRU register access clock
       - description: CRU image transfer clock
 
   clock-names:
-- 
2.43.0

Re: [PATCH] media: dt-bindings: renesas,rzg2l-cru: Improve documentation

[Rob Herring]

On Thu, Sep 05, 2024 at 08:18:01AM +0100, Biju Das wrote:
> Fix the documentation issues pointed by Pavel while backporting
> it to 6.1.y-cip.
>  - Replace 'input'->'inputs' in main description
>  - Replace 'Main'->'main' in CRU main clock description
>  - Replace 'Register'-> 'register' in CRU Register access clock
>    description
> 
> Reported-by: Pavel Machek <pavel@denx.de>
> Closes: https://lore.kernel.org/all/ZtWJqOdRxkBkUb9y@duo.ucw.cz/
> Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> ---
>  .../devicetree/bindings/media/renesas,rzg2l-cru.yaml        | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml b/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
> index bc1245127025..d3c74341febc 100644
> --- a/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
> +++ b/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
> @@ -13,7 +13,7 @@ maintainers:
>  description:
>    The CRU image processing module is a data conversion module equipped with pixel
>    color space conversion, LUT, pixel format conversion, etc. An MIPI CSI-2 input and
> -  parallel (including ITU-R BT.656) input are provided as the image sensor interface.
> +  parallel (including ITU-R BT.656) inputs are provided as the image sensor interface.

Are there multiple parallel inputs? If not, this change is wrong. The 
existing text is 'a foo input and bar input...'. It could be changed 
to 'foo and bar inputs...' though.

>  
>  properties:
>    compatible:
> @@ -38,8 +38,8 @@ properties:
>  
>    clocks:
>      items:
> -      - description: CRU Main clock
> -      - description: CRU Register access clock
> +      - description: CRU main clock
> +      - description: CRU register access clock
>        - description: CRU image transfer clock

I'd remove "CRU" instead.

>  
>    clock-names:
> -- 
> 2.43.0
> 

RE: [PATCH] media: dt-bindings: renesas,rzg2l-cru: Improve documentation

[Biju Das]

Hi Rob,

Thanks for the feedback.

> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: Monday, September 9, 2024 3:34 PM
> Subject: Re: [PATCH] media: dt-bindings: renesas,rzg2l-cru: Improve documentation
> 
> On Thu, Sep 05, 2024 at 08:18:01AM +0100, Biju Das wrote:
> > Fix the documentation issues pointed by Pavel while backporting it to
> > 6.1.y-cip.
> >  - Replace 'input'->'inputs' in main description
> >  - Replace 'Main'->'main' in CRU main clock description
> >  - Replace 'Register'-> 'register' in CRU Register access clock
> >    description
> >
> > Reported-by: Pavel Machek <pavel@denx.de>
> > Closes: https://lore.kernel.org/all/ZtWJqOdRxkBkUb9y@duo.ucw.cz/
> > Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> > ---
> >  .../devicetree/bindings/media/renesas,rzg2l-cru.yaml        | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git
> > a/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
> > b/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
> > index bc1245127025..d3c74341febc 100644
> > --- a/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
> > +++ b/Documentation/devicetree/bindings/media/renesas,rzg2l-cru.yaml
> > @@ -13,7 +13,7 @@ maintainers:
> >  description:
> >    The CRU image processing module is a data conversion module equipped with pixel
> >    color space conversion, LUT, pixel format conversion, etc. An MIPI
> > CSI-2 input and
> > -  parallel (including ITU-R BT.656) input are provided as the image sensor interface.
> > +  parallel (including ITU-R BT.656) inputs are provided as the image sensor interface.
> 
> Are there multiple parallel inputs? If not, this change is wrong. The existing text is 'a foo input
> and bar input...'. It could be changed to 'foo and bar inputs...' though.

No, it is "a foo input and bar input" this wording is in line with hardware manual.
So, I will leave like as it is.

> 
> >
> >  properties:
> >    compatible:
> > @@ -38,8 +38,8 @@ properties:
> >
> >    clocks:
> >      items:
> > -      - description: CRU Main clock
> > -      - description: CRU Register access clock
> > +      - description: CRU main clock
> > +      - description: CRU register access clock
> >        - description: CRU image transfer clock
> 
> I'd remove "CRU" instead.

OK, will remove "CRU" from description.

Cheers,
Biju

> 
> >
> >    clock-names:
> > --
> > 2.43.0
> >