apache / apache/arrow

[C++][Docs] Document our ABI stability policy

Open
#41,707 1 comment 0 reactions 0 assignees View on GitHub
Component: C++ Component: Documentation Component: Release
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

With the 16.1.0 release, there have been a few issues related to whether this minor / feature release is expected to be ABI stable or expected to have bumped the so version.:

- https://github.com/apache/arrow/issues/41659
- https://github.com/apache/arrow/issues/41679
- https://github.com/conda-forge/arrow-cpp-feedstock/pull/1409

Our release scripts _do_ bump the so version for minor releases, as has been discussed and implemented around the time of the first 1.0.0 release (https://github.com/apache/arrow/pull/4801, [mailing list thread](https://lists.apache.org/thread/r1ztq38xz5tn4p4v0xc1xk2d8x82p84v)).

However, we don't document this policy anywhere AFAIK (and there was clearly also confusion about this among the committers as well). We should document this in the C++ docs somewhere, that the so version is bumped for every major and minor version, and thus consequently that bug-fix releases are expected to be ABI stable.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.