diff options
author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2021-03-17 20:39:14 +0200 |
---|---|---|
committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2021-03-21 14:05:33 +0200 |
commit | ceff746690571092169729d62a3225b9a1a69f8d (patch) | |
tree | fb47fae5f9f1bbc9290b24a14b407acec367e362 /wiki/2016-10-miniperi/out_5.jpg | |
parent | 4d032271ce65f6ad816ca71cd8d77fc0b6f6fc1a (diff) |
scripts: Extend support for formatting comments
Now that comments can span multiple lines, add support for nested lists.
The yaml syntax is
comments:
- The BSP commit bundles 5 different changes:
- Disable SN65DSI86 GPIOs
- Disable scrambling (for V3U Falcon)
- Hot plug detectiong polling
- EDID retrieval
- 4k support for Display Port v1.2
which gets translated to
<ul>
<li>
<p>The BSP commit bundles 5 different changes</p>
<p>
<ul>
<li>
<p>Disable SN65DSI86 GPIOs</p>
</li>
<li>
<p>Disable scrambling (for V3U Falcon)</p>
</li>
<li>
<p>Hot plug detectiong polling</p>
</li>
<li>
<p>EDID retrieval</p>
</li>
<li>
<p>4k support for Display Port v1.2</p>
</li>
</ul>
</p>
</li>
</ul>
The YAML schema is relaxed accordingly to support sequences of anything
in comments.
Note the need for ':' at the end of the first line in the list. Without
that, the full comment will be treated as a single block of text by the
yaml parser, and the HTML generation script will render it as a single
paragraph without line breaks. This could be addressed, but if we keep
going further in that during, maybe a full markdown parser and generator
should be integrated instead.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
Diffstat (limited to 'wiki/2016-10-miniperi/out_5.jpg')
0 files changed, 0 insertions, 0 deletions