DOC: Add note about ITK release and remote module compatibility

InsightSoftwareConsortium / ITK

Insight Toolkit (ITK) -- Official Repository. ITK builds on a proven, spatially-oriented architecture for processing, segmentation, and registration of scientific images in two, three, or more dimensions.

https://itk.org

Apache License 2.0

1.37k stars 660 forks source link

DOC: Add note about ITK release and remote module compatibility #4765

Closed jhlegarreta closed 3 days ago

jhlegarreta commented 5 days ago

Add a note about the need to update the remote modules when a new ITK mjor/minor version is released.

PR Checklist

[X] No API changes were made (or the changes have been approved)
[X] No major design changes were made (or the changes have been approved)

SimonRit commented 4 days ago

I don't understand why remote modules should be bumped into a new major version for a minor version change of ITK. That wouldn't be my choice by default... Can you clarify why incompatibility of the binaries across ITK minor versions requires this?

thewtex commented 3 days ago

While we attempt to maintain API compatibility between ITK minor releases, the ABI generally changes. This can be due to features and bug fixes in the ITK source code, but there are also usually build system changes that cause ABI changes.