-
Notifications
You must be signed in to change notification settings - Fork 146
Add Copilot instructions for CMSIS Core version sync enforcement #298
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d7a6ee8
Add .github/copilot-instructions.md with CMSIS Core version sync remi…
Copilot ece9f35
Refine copilot-instructions.md: map each CORE component condition to …
Copilot 9fcec78
Potential fix for pull request finding
JonatanAntoni b7b2b4f
Extend CMSIS Core version sync instructions to Doxygen and history files
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Copilot Code Review Instructions | ||
|
|
||
| ## CMSIS Core version consistency | ||
|
|
||
| The CMSIS Core version is defined in two places that must always be kept in sync: | ||
|
|
||
| 1. **`ARM.CMSIS.pdsc`** (repo root) — three specific `<component Cclass="CMSIS" Cgroup="CORE">` entries, each identified by its `condition` attribute: | ||
| - `condition="ARMv6_7_8-M Device"` → Cortex-M component (maps to `__CM_` macros) | ||
| - `condition="ARMv7_8-A Device"` → Cortex-A component (maps to `__CA_` macros) | ||
| - `condition="ARMv7-R Device"` → Cortex-R component (maps to `__CR_` macros) | ||
|
|
||
| 2. **`CMSIS/Core/Include/cmsis_version.h`** — the preprocessor defines, grouped by device profile: | ||
| - `__CM_CMSIS_VERSION_MAIN` / `__CM_CMSIS_VERSION_SUB` (Cortex-M) | ||
| - `__CA_CMSIS_VERSION_MAIN` / `__CA_CMSIS_VERSION_SUB` (Cortex-A) | ||
| - `__CR_CMSIS_VERSION_MAIN` / `__CR_CMSIS_VERSION_SUB` (Cortex-R) | ||
|
|
||
| **Whenever a pull request modifies either of these files, verify that the version is consistent across both locations and remind the author to update the other location if it has not been updated.** | ||
|
|
||
| The version check must be done per device profile (A, M, R): | ||
|
|
||
| | `ARM.CMSIS.pdsc` component (`condition`) | `cmsis_version.h` macros | | ||
| |---|---| | ||
| | `Cversion` on `condition="ARMv6_7_8-M Device"` | `__CM_CMSIS_VERSION_MAIN` . `__CM_CMSIS_VERSION_SUB` | | ||
| | `Cversion` on `condition="ARMv7_8-A Device"` | `__CA_CMSIS_VERSION_MAIN` . `__CA_CMSIS_VERSION_SUB` | | ||
| | `Cversion` on `condition="ARMv7-R Device"` | `__CR_CMSIS_VERSION_MAIN` . `__CR_CMSIS_VERSION_SUB` | | ||
|
|
||
| For example, if `Cversion="6.2.0"` for the `ARMv6_7_8-M Device` component, then `__CM_CMSIS_VERSION_MAIN` must be `6` and `__CM_CMSIS_VERSION_SUB` must be `2`. Each profile's version must be checked independently. | ||
|
JonatanAntoni marked this conversation as resolved.
Outdated
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.