diff options
| author |  Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
| 2022-04-03 10:18:49 +0200 |
|---|---|---|
| committer |  Rob Herring <robh@kernel.org>
| 2022-04-04 19:55:03 -0500 |
| commit | 7a150b0d850e37e7bdfc87459edd0ff302f67478 (patch) | |
| tree | 8f8cd73f99195250f56c6dd1c38e72459ef54083 /Documentation/devicetree/bindings/writing-schema.rst | |
| parent | docs: dt: writing-bindings: describe typical cases (diff) | |
| download | linux-7a150b0d850e37e7bdfc87459edd0ff302f67478.tar.gz linux-7a150b0d850e37e7bdfc87459edd0ff302f67478.tar.bz2 linux-7a150b0d850e37e7bdfc87459edd0ff302f67478.zip | |
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: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20220403081849.8051-2-krzysztof.kozlowski@linaro.org
Diffstat (limited to 'Documentation/devicetree/bindings/writing-schema.rst')
| -rw-r--r-- | Documentation/devicetree/bindings/writing-schema.rst | 6 |
1 files changed, 6 insertions, 0 deletions
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 ------- |