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

API-breaking change between v0.7.4 and v0.7.5 #21

Open
jbweston opened this issue Nov 15, 2018 · 1 comment
Open

API-breaking change between v0.7.4 and v0.7.5 #21

jbweston opened this issue Nov 15, 2018 · 1 comment
Assignees

Comments

@jbweston
Copy link
Contributor

jbweston commented Nov 15, 2018

This issue was originally opened on the pylibdmtx wrapper, and it was suspected that it was a MacOS issue, however a little more probing suggests that this is not a platform-dependent issue.

Commit e4c0a74 introduced changes to the datastructures used by libdmtx. This means that any downstream tools that were compiled against an old version of libdmtx will break in strange ways.

Going forward Iit might be good to use a standard versioning scheme (e.g. semantic versioning). At the very least we should be bumping the SONAME whenever backwards-incompatible changes are made.

jbweston added a commit to jbweston/pylibdmtx that referenced this issue Nov 15, 2018
Between v0.7.4 and v0.7.5 libdmtx added a field to the internal
datastructures, which were not included into the wrapper in pylibdmtx.
The wrapper thus uses incorrect offsets to access the elements of the
datastructures, and this causes strange errors.

Reported upstream: dmtx/libdmtx#21

Closes NaturalHistoryMuseum#24.
@jbweston
Copy link
Contributor Author

jbweston commented Nov 15, 2018

At the very least, if we introduce extra fields to the datastructures, we should place them at the end, so that existing code does not break (the offsets to the existing fields will remain unchanged)

jbweston added a commit to jbweston/pylibdmtx that referenced this issue Jan 4, 2019
Between v0.7.4 and v0.7.5 libdmtx added a field to the internal
datastructures, which were not included into the wrapper in pylibdmtx.
The wrapper thus uses incorrect offsets to access the elements of the
datastructures, and this causes strange errors.

Reported upstream: dmtx/libdmtx#21

Closes NaturalHistoryMuseum#24.
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