dt-bindings: writing-schema: Add details on YAML text blocks
authorRob Herring (Arm) <robh@kernel.org>
Wed, 18 Sep 2024 19:51:30 +0000 (14:51 -0500)
committerRob Herring (Arm) <robh@kernel.org>
Tue, 8 Oct 2024 15:22:17 +0000 (10:22 -0500)
commit1d31c6fc86c09a2ed08e71a6bfae74bb1d7b116b
treec79f29940907187a70524b45c0ef29a65a768358
parent29bf3116cf2973bfaacce52e4e3a3b77719bae52
dt-bindings: writing-schema: Add details on YAML text blocks

The YAML format has a couple of different forms for multi-line text
blocks which control allowed characters and handling of line-breaks.
Getting this wrong is a common review issue. Either a literal block is
used when there's no formatting needed or a folded/literal block is
not used when there is formatting to maintain.

Add some descriptions of the different forms to point folks to in
reviews.

Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
Link: https://lore.kernel.org/r/20240918195130.2024205-2-robh@kernel.org
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
Documentation/devicetree/bindings/writing-schema.rst