[csolution] Add overview:
node to *.cbuild.yml
files with a reference to the "Overview" MD file specified in the package description file
#1963
Labels
enhancement
New feature or request
Describe The Problem To Be Solved
Allow an IDE to display the "Overview" MarkDown file optionally specified in the "overview=" attribute of the
<description>
tag in the package description file (*.pdsc
)Suggested Solution
a) Extend the
device-pack:
node with anoverview:
subnode in the*cbuild.yml
to provide this information.Extend the
board-pack:
node accordingly.b) Add an
overview:
sub-node to thepack:
node similar topath:
if an overview is specified for a pack.The drawback of a) is that this will not make
overview.md
files accessible, for Software Packs that are neither Board nor Device packs.The drawback of b) is that it requires an additional level of indirection to locate the file reference for a device / board.
We could implement a) and b) accepting redundant information in
*.cbuild.yml
.The text was updated successfully, but these errors were encountered: