Collection of Open-CMSIS-Pack Specification Changes

[ReinhardKeil]

Documentation Enhancements

• Inconsistency: Cversion attribute of components within a bundle is not allowed according to documentation (but allowed by schema and implementations) #274
• Cversion attribute in <condition> element does not allow to change major version #273
• Including csolution/cproject examples in Packs #122 - make it clear how to distribute examples.
• [Glossary] Proposing system description terminology #63 - add section Glossary to CMSIS-Toolbox documentation
• CMSIS-pack conditions : is the spec clear enough ? #56 - refer to MDK middleware and other good examples
• CMSIS-Pack conditions : only 1 condition per component ? #57
• CMSIS-Pack file attribute : copy not documented #58
• How to deliver layers ? #80 - need a good example that shows usage of layers

Documentation + Schema Enhancements

• PACK DATASHEET: Weakness: How to identify Provided Interfaces (API header files) of SW components #262

Documentation + Tool/Schema Enhancements

• Limit size of "description" attribute or element #275 (packchk, potentially schema)
• Would it make sense to have a XOR condition ? #240 - nice, potentially a duplicate that has impact on many tools
• Clarification required about variants #156 - it should be impossible to mix different component variants -> csolution supports it?
• Make software and licence information associated with packs easier to find #51 (packchk)

To Discuss

• Provide a way to select an <api> from a pack without implementation #256 - this might require an extension to the csolution tool
• Two steps further with the generator #202 - is this still relevant?
• How is the DEPRECATED indication handled ? #210 - should we remove features that are deprecated since >24 months?
• Numbers/star meaning in the XSD not explained #103 - releated to 210 - to deprecate features tools that consume packs need to be tolerant on old packs.
• How to indicate that a component of a given class must be the only one of its class in the project ? #194 - addressed with 263 (taxonomy), suggest to close it.
• As a software component developer, I want to keep *.pdsc file in software repository, so I can track it under version control together with code. #190 - can someone help to review existing tutorials? What to improve?
• What are the rules to submit a PR on the spec ? #132 - anything not working in our process today?

Related to CMSIS-Toolbox? Should it be moved?

• Pre_Include_Global.h Isn't Included for Assembler Files devtools#1314 -> moved to devtools
• CMSIS Tools: common message output format for error/warning/info devtools#1315 -> moved to devtools