-
Notifications
You must be signed in to change notification settings - Fork 97
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
Remove legacy C API [AP-1684] #1404
Merged
Merged
Conversation
This file contains 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
a7a528a
to
e4bac70
Compare
e4bac70
to
e9477b4
Compare
Do we have to change any of the header guards? |
sokhealy
reviewed
Apr 16, 2024
sokhealy
approved these changes
Apr 18, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Besides the above comments I don't see any issue with the changes here.
952206b
to
3507582
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Removal Warning
This PR will be merged on 8/4/2024. On this date the legacy C API will become unavailable, it will not be reintroduced. On or shortly after this date libsbp version v6.0.0 will be tagged and released
Description
@swift-nav/devinfra
Remove legacy C API including all generated code, examples, templates, and sbpg module.
Remove all references to "v4" API which were lying around in a handful of places. There is no such thing as the V4 API any more, there is just the libsbp API
API compatibility
Yes
Legacy C API completely removed including:
struct msg_xxx_t
#define
s message types - in the formSBP_MSG_XXX
LegacyState
wrapperlibsbp/legacy
directorylibsbp/v4/<package.h>
API compatibility plan
The modern API was introduce to this repository in Sep 2021. The legacy API was retained but all symbols were marked as deprecated and compile time messages were output by GCC and Clang whenever a legacy header was used
In Dec 2023 the legacy was moved to a more difficult to access place. It was no longer accessible simply by include
libsbp/sbp.h
All headers were retained but even more compile time messages were added indicating that these files would be deleted in the next major versionThis PR is the final stage of the deprecation plan. Any users of this repository should have already converted their code to use the moden API.
JIRA Reference
https://swift-nav.atlassian.net/browse/AP-1684