[1/4] dt-bindings: arm: fix Rockchip Kylin board bindings
diff mbox series

Message ID 20200228061436.13506-1-jbx6244@gmail.com
State New
Headers show
Series
  • [1/4] dt-bindings: arm: fix Rockchip Kylin board bindings
Related show

Commit Message

Johan Jonker Feb. 28, 2020, 6:14 a.m. UTC
A test with the command below gives this error:

arch/arm/boot/dts/rk3036-kylin.dt.yaml: /: compatible:
['rockchip,rk3036-kylin', 'rockchip,rk3036']
is not valid under any of the given schemas

Fix this error by changing 'rockchip,kylin-rk3036' to
'rockchip,rk3036-kylin' in rockchip.yaml.

make ARCH=arm dtbs_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/arm/rockchip.yaml

Signed-off-by: Johan Jonker <jbx6244@gmail.com>
---
 Documentation/devicetree/bindings/arm/rockchip.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Robin Murphy Feb. 28, 2020, 12:35 p.m. UTC | #1
On 28/02/2020 6:14 am, Johan Jonker wrote:
> A test with the command below gives this error:
> 
> arch/arm/boot/dts/rk3036-kylin.dt.yaml: /: compatible:
> ['rockchip,rk3036-kylin', 'rockchip,rk3036']
> is not valid under any of the given schemas
> 
> Fix this error by changing 'rockchip,kylin-rk3036' to
> 'rockchip,rk3036-kylin' in rockchip.yaml.

Although I can guess, it might be worth a note to explain why it's the 
binding rather than the DTS that gets changed here.

Robin.

> make ARCH=arm dtbs_check
> DT_SCHEMA_FILES=Documentation/devicetree/bindings/arm/rockchip.yaml
> 
> Signed-off-by: Johan Jonker <jbx6244@gmail.com>
> ---
>   Documentation/devicetree/bindings/arm/rockchip.yaml | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/arm/rockchip.yaml b/Documentation/devicetree/bindings/arm/rockchip.yaml
> index 874b0eaa2..203158038 100644
> --- a/Documentation/devicetree/bindings/arm/rockchip.yaml
> +++ b/Documentation/devicetree/bindings/arm/rockchip.yaml
> @@ -443,7 +443,7 @@ properties:
>   
>         - description: Rockchip Kylin
>           items:
> -          - const: rockchip,kylin-rk3036
> +          - const: rockchip,rk3036-kylin
>             - const: rockchip,rk3036
>   
>         - description: Rockchip PX3 Evaluation board
>
Johan Jonker Feb. 28, 2020, 12:50 p.m. UTC | #2
On 2/28/20 1:35 PM, Robin Murphy wrote:
> On 28/02/2020 6:14 am, Johan Jonker wrote:
>> A test with the command below gives this error:
>>
>> arch/arm/boot/dts/rk3036-kylin.dt.yaml: /: compatible:
>> ['rockchip,rk3036-kylin', 'rockchip,rk3036']
>> is not valid under any of the given schemas
>>
>> Fix this error by changing 'rockchip,kylin-rk3036' to
>> 'rockchip,rk3036-kylin' in rockchip.yaml.
> 


> Although I can guess, it might be worth a note to explain why it's the
> binding rather than the DTS that gets changed here.

Hi Robin,

My guess is that given a look at the other boards the processor name
comes first and then the board name, so I changed it in rockchip.yaml.
But maybe Heiko can better explain what the naming consensus in the past
was.

Kind regards,

Johan

> 
> Robin.
> 
>> make ARCH=arm dtbs_check
>> DT_SCHEMA_FILES=Documentation/devicetree/bindings/arm/rockchip.yaml
>>
>> Signed-off-by: Johan Jonker <jbx6244@gmail.com>
>> ---
>>   Documentation/devicetree/bindings/arm/rockchip.yaml | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/devicetree/bindings/arm/rockchip.yaml
>> b/Documentation/devicetree/bindings/arm/rockchip.yaml
>> index 874b0eaa2..203158038 100644
>> --- a/Documentation/devicetree/bindings/arm/rockchip.yaml
>> +++ b/Documentation/devicetree/bindings/arm/rockchip.yaml
>> @@ -443,7 +443,7 @@ properties:
>>           - description: Rockchip Kylin
>>           items:
>> -          - const: rockchip,kylin-rk3036
>> +          - const: rockchip,rk3036-kylin
>>             - const: rockchip,rk3036
>>           - description: Rockchip PX3 Evaluation board
>>
Heiko Stuebner Feb. 29, 2020, 11:55 p.m. UTC | #3
Hi Johan,

Am Freitag, 28. Februar 2020, 13:50:11 CET schrieb Johan Jonker:
> On 2/28/20 1:35 PM, Robin Murphy wrote:
> > On 28/02/2020 6:14 am, Johan Jonker wrote:
> >> A test with the command below gives this error:
> >>
> >> arch/arm/boot/dts/rk3036-kylin.dt.yaml: /: compatible:
> >> ['rockchip,rk3036-kylin', 'rockchip,rk3036']
> >> is not valid under any of the given schemas
> >>
> >> Fix this error by changing 'rockchip,kylin-rk3036' to
> >> 'rockchip,rk3036-kylin' in rockchip.yaml.
> > 
> 
> 
> > Although I can guess, it might be worth a note to explain why it's the
> > binding rather than the DTS that gets changed here.
> 
> Hi Robin,
> 
> My guess is that given a look at the other boards the processor name
> comes first and then the board name, so I changed it in rockchip.yaml.
> But maybe Heiko can better explain what the naming consensus in the past
> was.


I think what Robin meant was that there should be an explanation in the
commit message on why you change the binding and not the board.

Normally the dt-binding is the authoritative part, so boards should follow
the binding, but in the kylin-case the compatible from the .dts is used fr
years in the field now, so you're correct to fix the binding, as otherwise
we would break old users.

So just add a paragraph to the commit message with the above ;-)

Heiko

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/arm/rockchip.yaml b/Documentation/devicetree/bindings/arm/rockchip.yaml
index 874b0eaa2..203158038 100644
--- a/Documentation/devicetree/bindings/arm/rockchip.yaml
+++ b/Documentation/devicetree/bindings/arm/rockchip.yaml
@@ -443,7 +443,7 @@  properties:
 
       - description: Rockchip Kylin
         items:
-          - const: rockchip,kylin-rk3036
+          - const: rockchip,rk3036-kylin
           - const: rockchip,rk3036
 
       - description: Rockchip PX3 Evaluation board