michaelh/zephyr
1
0
Fork 0
Code Releases Activity

dts: bindings: Preserve newlines in descriptions

Browse source 
With https://github.com/zephyrproject-rtos/zephyr/pull/20185, multi-line
descriptions will be formatted nicely, but using '>' breaks it, because
it removes internal newlines (including between paragraphs).

See https://yaml-multiline.info/.

Replace 'description: >' with 'description: |' to encourage '|'. That'll
prevent '>' from getting copied around and messing up long descriptions.

This will lead to some extra newlines in the output, but it's fine.
Line-wrapping messes up any manual formatting.

The replacement was done with

    $ git ls-files 'dts/bindings/*.yaml' | \
          xargs sed -i 's/description:\s*>/description: |/'

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
This commit is contained in:
Ulf Magnusson 2019-10-28 17:34:12 +01:00 • committed by Kumar Gala
commit b9240a3cbc
351 changed files with 351 additions and 351 deletions
Download patch file Download diff file Expand all files Collapse all files

2
dts/bindings/riscv/openisa,rv32m1-pcc.yaml
View file

@ -3,7 +3,7 @@
title: RV32M1 PCC (Peripheral Clock Control)
description: >
description: |
This is a representation of the RV32M1 PCC IP node
compatible: "openisa,rv32m1-pcc"