| Message ID | 20220403081849.8051-2-krzysztof.kozlowski@linaro.org |
|---|---|
| State | Accepted, archived |
| Headers | show |
| Series | [1/2] docs: dt: writing-bindings: describe typical cases | expand |
| Context | Check | Description |
|---|---|---|
| robh/checkpatch | success | |
| robh/patch-applied | success | |
| robh/dtbs-check | success | |
| robh/dt-meta-schema | success |
On Sun, 03 Apr 2022 10:18:49 +0200, Krzysztof Kozlowski wrote: > 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: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> > --- > .../devicetree/bindings/example-schema.yaml | 14 +++++++------- > .../devicetree/bindings/writing-schema.rst | 6 ++++++ > 2 files changed, 13 insertions(+), 7 deletions(-) > Applied, thanks!
diff --git a/Documentation/devicetree/bindings/example-schema.yaml b/Documentation/devicetree/bindings/example-schema.yaml index 80a28781845d..8e1a8b19d429 100644 --- a/Documentation/devicetree/bindings/example-schema.yaml +++ b/Documentation/devicetree/bindings/example-schema.yaml @@ -249,13 +249,13 @@ 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"; - reg = <0x1000 0x80>, - <0x3000 0x80>; - reg-names = "core", "aux"; - interrupts = <10>; - interrupt-controller; + compatible = "vendor,soc4-ip", "vendor,soc1-ip"; + reg = <0x1000 0x80>, + <0x3000 0x80>; + reg-names = "core", "aux"; + interrupts = <10>; + interrupt-controller; }; diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst index 95ecf55559e5..2916edf829db 100644 --- a/Documentation/devicetree/bindings/writing-schema.rst +++ b/Documentation/devicetree/bindings/writing-schema.rst @@ -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 -------
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: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> --- .../devicetree/bindings/example-schema.yaml | 14 +++++++------- .../devicetree/bindings/writing-schema.rst | 6 ++++++ 2 files changed, 13 insertions(+), 7 deletions(-)