diff options
| author | Joe Stringer <joe@ovn.org> | 2017-04-26 13:47:49 -0700 |
|---|---|---|
| committer | Joe Stringer <joe@ovn.org> | 2017-05-17 15:10:34 -0700 |
| commit | f12e09b7b2e50ba8df7aad6fc1d78b87c9a346c6 (patch) | |
| tree | 0c68fea8b0da68e1fc2ad3d2bf133a0ef55cc57d /Documentation/internals | |
| parent | 621268a6143a3e05480c021a2e97dfc90ec52ae3 (diff) | |
| download | openvswitch-f12e09b7b2e50ba8df7aad6fc1d78b87c9a346c6.tar.gz | |
libopenvswitch: Rename to libfoo-X.Y.
The current intent for Open vSwitch is to maintain libopenvswitch ABI
stability for minor versions, for example each release within the 2.7.z
series. According to the following documentation, no changes to exported
headers should be made.
http://docs.openvswitch.org/en/latest/internals/contributing/libopenvswitch-abi/
However, it is occasionally necessary to make changes to
{include/openvswitch,lib}/*.h headers to fix issues within a given
release series. The current libtool tagging mechanism in the build
system does not allow for this without creating a conflict between the
libtool 'current' version and the next minor release of OVS.
This patch modifies libopenvswitch build to include the MAJOR.MINOR
release version in the libX name, and include the libtool CURRENT and
OVS MICRO release in the libtool versioning tags to indicate library
stability. The resulting format is "libfoo-X.Y.so.CURRENT.0.Z" for OVS
release "X.Y.Z".
Developers should still attempt to avoid introducing ABI-breaking changes
within a particular OVS-X.Y release series, but if this is not possible
this patch introduced a mechanism to allow an ABI-breaking fix to be
introduced. In such a case, developers may update the libtool CURRENT
version to indicate this breakage to library users.
Signed-off-by: Joe Stringer <joe@ovn.org>
Acked-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/internals')
| -rw-r--r-- | Documentation/internals/contributing/libopenvswitch-abi.rst | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/Documentation/internals/contributing/libopenvswitch-abi.rst b/Documentation/internals/contributing/libopenvswitch-abi.rst index 845d90898..8fa24db96 100644 --- a/Documentation/internals/contributing/libopenvswitch-abi.rst +++ b/Documentation/internals/contributing/libopenvswitch-abi.rst @@ -87,16 +87,18 @@ ABI Policy ---------- Open vSwitch will export the ABI version at the time of release, such that the -library name will be the major version, and the rest of the release version -information will be conveyed with a libtool interface version. +library name will be the major.minor version, and the rest of the release +version information will be conveyed with a libtool interface version. The intent is for Open vSwitch to maintain an ABI stability for each minor revision only (so that Open vSwitch release 2.5 carries a guarantee for all -2.5.ZZ micro-releases). This means that any porting effort to stable branches -must take not to disrupt the existing ABI. Each new 'minor-level' release -bumps the libtool 'current' version, which informs the linker of a backwards -incompatible interface, signaling that libraries exposed by Open vSwitch 2.6 -will not maintain ABI stability with Open vSwitch 2.5. +2.5.ZZ micro-releases). This means that any porting effort to stable branches +must take not to disrupt the existing ABI. + +In the event that a bug must be fixed in a backwards-incompatible way, +developers must bump the libtool 'current' version to inform the linker of the +ABI breakage. This will signal that libraries exposed by the subsequent release +will not maintain ABI stability with the previous version. Coding ------- |