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

Improved node descriptions for IntelliSense #1866

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

vovamarch
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@brondani brondani left a comment

Choose a reason for hiding this comment

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

I would also suggest revising the final dot . in all descriptions and make it consistent.

tools/projmgr/schemas/common.schema.json Outdated Show resolved Hide resolved
},
"ProcessorDsp": {
"enum": [ "on", "off" ],
"description": "Controls usage of DSP: on (enabled) | off (disabled)"
"description": "Controls usage of SIMD instructions:\n on (enabled) | off (disabled) ."
Copy link
Collaborator

Choose a reason for hiding this comment

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

The dsp node concerns DSP extensions, for example disabling the DSP for Cortex-M33 will result in the following AC6 flag: -mcpu=Cortex-M33+nodsp
SIMD flags such as -fvectorize are not yet abstracted via dedicated yaml nodes.

Suggested change
"description": "Controls usage of SIMD instructions:\n on (enabled) | off (disabled) ."
"description": "Controls usage of DSP extensions:\n on (enabled) | off (disabled) ."

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Documentation mentions SIMD. Agree that "DSP" itself has not so clear definition in this context. Then documentation would need to explain what it means for what CPUs. Maybe https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md#processor

tools/projmgr/schemas/cproject.schema.json Outdated Show resolved Hide resolved
@vovamarch
Copy link
Collaborator Author

I would also suggest revising the final dot . in all descriptions and make it consistent.

I changed to have end the descriptions with a dot.

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.95%. Comparing base (295825a) to head (f50670b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1866   +/-   ##
=======================================
  Coverage   64.95%   64.95%           
=======================================
  Files         163      163           
  Lines       34552    34552           
  Branches    20043    20043           
=======================================
  Hits        22442    22442           
  Misses       7959     7959           
  Partials     4151     4151           
Flag Coverage Δ
projmgr-cov 81.69% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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.

2 participants