Skip to content

Update YML input format documentation#553

Merged
jthuangarm merged 3 commits into
Open-CMSIS-Pack:mainfrom
jthuangarm:main
Mar 18, 2026
Merged

Update YML input format documentation#553
jthuangarm merged 3 commits into
Open-CMSIS-Pack:mainfrom
jthuangarm:main

Conversation

@jthuangarm

@jthuangarm jthuangarm commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

Clarify bundle consistency rules for components for Open-CMSIS-Pack/devtools#2401

Checklist

  • 🤖 This change is covered by unit tests (if applicable).
  • 🤹 Manual testing has been performed (if necessary).
  • 🛡️ Security impacts have been considered (if relevant).
  • 📖 Documentation updates are complete (if required).
  • 🧠 Third-party dependencies and TPIP updated (if required).

Clarify bundle consistency rules for components.
@brondani

Copy link
Copy Markdown
Collaborator

@jkrech Can you please review this documentation change concerning bundles?

Regarding the error message, is this ok or would you require any refinement?

error csolution: components from multiple bundles are specified:
    - ARM::RteTestBundle&BundleOne:G0
    - SomeVendor::RteTestBundle&BundleTwo:G0

@brondani brondani requested review from jkrech and removed request for brondani March 17, 2026 12:06
@jkrech

jkrech commented Mar 17, 2026

Copy link
Copy Markdown
Member

The error text above does not specify the rule that has been violated.

error csolution: Selected components belonging to the the same Cclass must not come from a different Cbundle.
Conflicting bundles: `&BundleOne` and `&BundleTwo` in components:
  - ARM::RteTestBundle&BundleOne:G0
  - SomeVendor::RteTestBundle&BundleTwo:G0
  - ...

I did not find a way to shorten it. Maybe you do.

@jthuangarm

Copy link
Copy Markdown
Contributor Author

I would suggest the error message could be a bit shorter if we structure it like this:

error csolution: components in Cclass `RteTestBundle` must belong to the same Cbundle.
Conflicting bundles:
  - &BundleOne
  - &BundleTwo
Affected components:
  - ARM::RteTestBundle&BundleOne:G0
  - SomeVendor::RteTestBundle&BundleTwo:G0

@jthuangarm

Copy link
Copy Markdown
Contributor Author

@jkrech The rules have been refined. Please review them again.

Clarified rules regarding component definitions and variants in csolution project files.
@jkrech jkrech requested a review from brondani March 18, 2026 14:43

@jkrech jkrech left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please review my suggested changes.

@brondani brondani left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jthuangarm jthuangarm merged commit de0a90f into Open-CMSIS-Pack:main Mar 18, 2026
4 checks passed
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

Successfully merging this pull request may close these issues.

3 participants