Commit 7a150b0d authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Rob Herring
Browse files

docs: dt: writing-schema: mention coding style 



Mention the usage of YAML coding style.  Describe explicitly that
four-space indentation in DTS examples is preferred, because:
1. The YAML's default two-space indentation for DTS code makes it
   significantly less readable.
2. Linux coding style tabs would introduce inconsistency (entire file is
   indented with spaces).
3. On the other hand, eight spaces would not align with example's
   opening '  - |' part.  Four spaces makes the code nicely aligned with
   it.

Signed-off-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20220403081849.8051-2-krzysztof.kozlowski@linaro.org
parent 44c8a51a

Documentation/devicetree/bindings/example-schema.yaml

+7 −7
Original line number Diff line number Diff line
@@ -249,7 +249,7 @@ examples: 
  # be overridden or an appropriate parent bus node should be shown (such as on

  # i2c buses).

  #

  # Any includes used have to be explicitly included.

  # Any includes used have to be explicitly included. Use 4-space indentation.

  - |

    node@1000 {

        compatible = "vendor,soc4-ip", "vendor,soc1-ip";

Documentation/devicetree/bindings/writing-schema.rst

+6 −0
Original line number Diff line number Diff line
@@ -108,6 +108,12 @@ The YAML Devicetree format also makes all string values an array and scalar 
values a matrix (in order to define groupings) even when only a single value

is present. Single entries in schemas are fixed up to match this encoding.



Coding style

------------



Use YAML coding style (two-space indentation). For DTS examples in the schema,

preferred is four-space indentation.



Testing

-------