This is merely a historical archive of years 2008-2021, before the migration to mailman3.
A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.
Neels Hofmeyr gerrit-no-reply at lists.osmocom.orgReview at https://gerrit.osmocom.org/4000 tweak API version comments Clarify LIBVERSION comments in TODO-RELEASE and reference Makefile.am comments to look there. Change-Id: I4edf786fde085f612f8a04972c55175a080ac65f --- M TODO-RELEASE M src/libosmo-legacy-mgcp/Makefile.am M src/libosmo-mgcp-client/Makefile.am 3 files changed, 30 insertions(+), 14 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-mgw refs/changes/00/4000/1 diff --git a/TODO-RELEASE b/TODO-RELEASE index d0852fc..435f67f 100644 --- a/TODO-RELEASE +++ b/TODO-RELEASE @@ -1,9 +1,27 @@ -# When cleaning up this file: bump API version in corresponding Makefile.am and rename corresponding debian/lib*.install -# according to https://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html#Updating-version-info -# In short: -# LIBVERSION=c:r:a -# If the library source code has changed at all since the last update, then increment revision: c:r + 1:a. -# If any interfaces have been added, removed, or changed since the last update: c + 1:0:0. -# If any interfaces have been added since the last public release: c:r:a + 1. -# If any interfaces have been removed or changed since the last public release: c:r:0. +# When cleaning up this file upon a release: +# +# - Note that the release version number is entirely unrelated to the API +# versions. We may choose to coincide the release major to the API current, +# but that is merely circumstantial. +# +# - Bump API version in src/lib*/Makefile.am files according to chapter +# "Library interface versions" of the libtool documentation. +# https://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html +# +# - Iff the 'current' API version has changed, rename debian/lib*.install +# +# API version bumping for the impatient: +# LIBVERSION=c:r:a (current:revision_of_current:backwards_compat_age) +# 5:2:4 means that +# - this implements version 5 of the API; +# - this is the 2nd (compatible) revision of API version 5; +# - this is backwards compatible to all APIs since 4 versions ago, +# i.e. callers that need API versions from 1 to 5 can use this. +# +# Bumping API versions recipe: +# If the library source code has changed at all since the last update, r++; +# If any interfaces have been added, removed, or changed since the last update, c++, r=0; +# If any interfaces have been added since the last public release, a++; +# If any interfaces have been removed or changed since the last public release, a=0. +# #library what description / commit summary line diff --git a/src/libosmo-legacy-mgcp/Makefile.am b/src/libosmo-legacy-mgcp/Makefile.am index 32902b9..bcf6242 100644 --- a/src/libosmo-legacy-mgcp/Makefile.am +++ b/src/libosmo-legacy-mgcp/Makefile.am @@ -21,9 +21,8 @@ $(LIBBCG729_LIBS) \ $(NULL) -# This is _NOT_ the library release version, it's an API version. -# Please read Chapter 6 "Library interface versions" of the libtool -# documentation before making any modification +# This is not at all related to the release version, but a range of supported +# API versions. Read TODO_RELEASE in the source tree's root! LEGACY_MGCP_LIBVERSION=0:0:0 lib_LTLIBRARIES = \ diff --git a/src/libosmo-mgcp-client/Makefile.am b/src/libosmo-mgcp-client/Makefile.am index e644862..b17477a 100644 --- a/src/libosmo-mgcp-client/Makefile.am +++ b/src/libosmo-mgcp-client/Makefile.am @@ -19,9 +19,8 @@ $(COVERAGE_LDFLAGS) \ $(NULL) -# This is _NOT_ the library release version, it's an API version. -# Please read Chapter 6 "Library interface versions" of the libtool -# documentation before making any modification +# This is not at all related to the release version, but a range of supported +# API versions. Read TODO_RELEASE in the source tree's root! MGCP_CLIENT_LIBVERSION=0:0:0 lib_LTLIBRARIES = \ -- To view, visit https://gerrit.osmocom.org/4000 To unsubscribe, visit https://gerrit.osmocom.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I4edf786fde085f612f8a04972c55175a080ac65f Gerrit-PatchSet: 1 Gerrit-Project: osmo-mgw Gerrit-Branch: master Gerrit-Owner: Neels Hofmeyr <nhofmeyr at sysmocom.de>