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

Add a Revision History to the Spec #154

Open
mobilinkd opened this issue Feb 13, 2025 · 0 comments
Open

Add a Revision History to the Spec #154

mobilinkd opened this issue Feb 13, 2025 · 0 comments

Comments

@mobilinkd
Copy link
Contributor

Please add a Protocol Revision History which lists substantive changes, especially those that would break backwards compatibility with existing implementations. I have not followed changes to the spec for a bit and would like to update my implementations. But it is not clear what part of the OTA protocol has changed and when. The git commit history is valuable, but is no substitute for a concise revision history as the git history contains a lot of noise from reformatting and clarifications that don't substantively modify the protocol. I am not necessarily suggesting that we go back and document prior changes, just that any new changes are documented in a Revision History section.

Please also add a version number to the spec using semantic versioning, and tag those versions in Git. This means breaking changes (any change that could cause devices in the field to no longer interoperate) will have the major version number increased, any extensions result in the minor version being incremented, and any reformatting or clarification receives a patch-level change.

Changes that break backwards compatibility in a meaningful way should be very carefully considered now that commercial products implementing M17 exist. Even substantive extensions to M17 may result in future incompatibilities in the field.

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

No branches or pull requests

1 participant