Skip to content

Comments

Update hub versionings for semver use#96

Merged
aacuevas merged 3 commits intomainfrom
issue-95
Mar 6, 2025
Merged

Update hub versionings for semver use#96
aacuevas merged 3 commits intomainfrom
issue-95

Conversation

@aacuevas
Copy link
Contributor

@aacuevas aacuevas commented Mar 5, 2025

  • Update hub firmware version and oni spec version
  • These versions now follow semver, which is also linked
  • Added some spacings to the address explaining block, as it looked too crowded to me without those
  • Fixes Make hub firmware version follow semver #95

Regarding the format of the versions, I have changed it from Major.Minor.Patch.Reserved to Reserved.Major.Minor.Patch for the following reasons:

  • It makes sense to me that the proper versioning is on the lower bytes. Reserved ones are for the semver extension of development build, which we might use internally
  • On that regard, all the addresses or similar that have bits selecting a "special" meaning have them at the top
  • Additionally, it will help existing hardware to understand the versioning without breaking too much. Even if a major release breaks the API, we want software to be able to read the versions do it can declare itself incompatible if needed.

@aacuevas aacuevas requested a review from jonnew March 5, 2025 22:52
- Minor edits to formatting and text
Copy link
Member

@jonnew jonnew left a comment

Choose a reason for hiding this comment

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

I made some minor changes to the page, please have a quick look before merging.

@aacuevas
Copy link
Contributor Author

aacuevas commented Mar 6, 2025

Seems good, changes make reading flow better. Merging.

@aacuevas aacuevas merged commit ebe8c22 into main Mar 6, 2025
2 checks passed
@aacuevas aacuevas deleted the issue-95 branch March 6, 2025 23:54
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.

Make hub firmware version follow semver

2 participants