Open-CMSIS-Pack / Open-CMSIS-Pack-Spec

Common Microcontroller Software Interface Standard - Pack(age) based distribution system
https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/
Apache License 2.0
53 stars 21 forks source link

<examples> element: add environment name="cmsis", make <attributes> optional #226

Closed ReinhardKeil closed 1 year ago

ReinhardKeil commented 1 year ago

I suggest for the \<examples> element:

This is how an example would be described:

<examples>
   <example name="retarget" folder="example" doc="README.md">
     <description>Simple example retargeting stdout to USART.</description>
     <board name="V2M-MPS2" vendor="ARM"/>
     <project>
       <environment name="cmsis" load="retarget.csolution.yml"/>
     </project>
  </example>
</examples>
fred-r commented 1 year ago

Hi @ReinhardKeil,

on ST side, we plan to use the <examples> element to deliver our example projects for IDEs like EWARM. So, we would like to keep all the existing possibilities of the tag.

By the way, how do you plan to make it possible to deliver csolution/cproject-based projects ?

Thanks & Regards, Fred

ReinhardKeil commented 1 year ago

The environment name="cmsis" would refer to "*.csolution.yml" based projects with the assumption that an compatible IDE can import them.

Does ST use the \<attributes> that are currently used for examples? We are nowhere using it (not on web, not in IDEs), and it just makes it more complicated to publish examples. Most of the information should be anyway in the *.yml files going forward.

ReinhardKeil commented 1 year ago

Conclusion on the TRM 11. April 23: make optional, but not mandatory.

jkrech commented 1 year ago

PACK Specification updated to make attributes in example optional. environment names are not restricted by the specification.