Commit 292d25e
authored
[Comgr] Document API versioning rule in AGENT_CONVENTIONS.md (#3135)
## Summary
Adds an explicit API-versioning rule to `amd/comgr/AGENT_CONVENTIONS.md`
(section 4, PR workflow): every commit that adds a public
`AMD_COMGR_API` function must bump the minor version in `VERSION.txt`
and tag the new prototype with a fresh `AMD_COMGR_VERSION_X_Y` macro.
This codifies the policy that surfaced when #3008 added
`amd_comgr_hotswap_rewrite_with_options` under the already-used `3.3`
version without bumping (fixed in its follow-up #3134).
The rule captures:
- One bump per commit, not per function.
- Never reuse the current version's macro for a new API in a later
commit.
- Don't wait for an official release to bump — we don't know which
commit lands in each release, so the version advances when the API is
introduced.
- Add the symbol to `exportmap.in` under a version node matching the new
tag.
- `check_api_consistency.py` only enforces `VERSION.txt >=` the highest
macro, so it cannot catch version reuse — verify the bump by hand.
## Changes
- `AGENT_CONVENTIONS.md`: add the "Bump the version when adding a public
API" subsection.1 parent 58b8c0f commit 292d25e
1 file changed
Lines changed: 19 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
144 | 144 | | |
145 | 145 | | |
146 | 146 | | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
147 | 166 | | |
148 | 167 | | |
149 | 168 | | |
| |||
0 commit comments