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

Unclear documentation on what child elements are mandatory to have in case of inheritance #180

Open
vovamarch opened this issue Dec 9, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@vovamarch
Copy link

vovamarch commented Dec 9, 2022

Spec documentation states for inheritable child elements "Occurrence" as "0..*" or "0..1", meaning "optional", as they can also be defined in other levels. But some of these elements can be actually mandatory to have (even if via inheritance), and errors are returned by PackChk if not found, while other elements with similar "Occurrence" values can be optional to have and do not cause errors.

For example description of the <device> element (and its upper layers) gives an impression that only Dname is mandatory in it , but PackChk would report an error if is not present. However, no errors are reported if other possible elements such as <memory> or <flashinfo> are absent for <device>.

Spec shall provide more clear statement for mandatory and option child elements.

@jkrech jkrech added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 17, 2023
@ReinhardKeil ReinhardKeil self-assigned this Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants