Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ReinhardKeil opened this issue Oct 24, 2023 · 0 comments

Comments

@ReinhardKeil
Copy link
Collaborator

ReinhardKeil commented Oct 24, 2023

The pack https://github.com/Open-CMSIS-Pack/lwIP highlights a weakness. It is currently impossible:

  • to clearly identify the API header files of a component. This could be achievable with the file category "header", but lwIP has many different header files, each describing a different type of API, i.e. udp.h, sockets.h, etc. Not every header files is a user facing API. An attribute brief or a child element <description> may solve the problem to understand the purpose of the header file(s).

  • The API header files are in a sub-directory, lwip and the software component itself expects this directory structure. While it is possible to define an "path" for file category "header", this is not used in this pack; perhaps because examples are missing.

See also: #260

@ReinhardKeil ReinhardKeil changed the title SW DATASHEET: Weakness: How to identify Provided Interfaces (API header files) of SW components PACK DATASHEET: Weakness: How to identify Provided Interfaces (API header files) of SW components Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant