Re: [PATCH v2] docs: dt-bindings: add DTS Coding Style document

From: Krzysztof Kozlowski
Date: Wed Nov 22 2023 - 03:19:01 EST


On 21/11/2023 08:47, Krzysztof Kozlowski wrote:
> On 20/11/2023 21:15, Andrew Lunn wrote:
>>> +Naming and Valid Characters
>>> +---------------------------
>>> +
>>> +1. Node and property names are allowed to use only:
>>> +
>>> + * lowercase characters: [a-z]
>>> + * digits: [0-9]
>>> + * dash: -
>>> +
>>> +2. Labels are allowed to use only:
>>> +
>>> + * lowercase characters: [a-z]
>>> + * digits: [0-9]
>>> + * underscore: _
>>> +
>>> +3. Unit addresses should use lowercase hex, without leading zeros (padding).
>>> +
>>> +4. Hex values in properties, e.g. "reg", should use lowercase hex. The address
>>> + part can be padded with leading zeros.
>>> +
>>> +Example::
>>> +
>>> + gpi_dma2: dma-controller@800000 {
>>> + compatible = "qcom,sm8550-gpi-dma", "qcom,sm6350-gpi-dma";
>>> + reg = <0x0 0x00800000 0x0 0x60000>;
>>> + }
>>
>> Hi Krzysztof
>>
>> What i like about the Linux Coding Style is that most sections have a
>> Rationale. I like the way it explains the 'Why?'. It makes it feel
>> less arbitrary. When it does not seem arbitrary, but reasoned, i find
>> it easier to follow.
>>
>> Could you add rationale like the Coding Style?
>
> I did not do it on purpose because it would grow too much.

I added short rationale in coming v3.

Best regards,
Krzysztof