search

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
50 stars 20 forks source link

Proposal: Component Taxonomy is insufficient - can Pack Datasheets fill a gap? #260

Open jkrech opened 9 months ago

jkrech commented 9 months ago

This issue is to capture feedback to the idea of extracting a human readable document Pack Data Sheet from the pdsc. Today we render searchable device and board pages from pdsc files but not for packs (software).

PackDataSheet.pdf

From Meeting: https://linaro.atlassian.net/wiki/spaces/CMSIS/pages/29036806164/Open-CMSIS-Pack+Technical+Meeting+2023-10-17

ReinhardKeil commented 9 months ago

A possible example of a datasheet content is here: https://github.com/ReinhardKeil/lwIP/tree/patch-1#readme

Weakness: Provided Interfaces (API header files)

PackDataSheet.pdf highlights Provided Interfaces as a weakness. This is exemplified by lwIP where multiple header files are used to define various interfaces. In addition, the header file name also contains a sub-pathname:

#include "lwip/tcp.h"    // defines the tcp API of lwIP

See also https://github.com/Open-CMSIS-Pack/lwIP/issues/1

We may need to consider also how API header files are exposed to the user. In uVision this is done in the editor dialog only (the current dialog is overloaded on complex applications): image