[libchamplain] Add a comment about incrementing library version string



commit 3ff002ade72a47c0a755183bd563434fdeba4bdf
Author: JiÅ?í Techet <techet gmail com>
Date:   Tue May 18 22:42:42 2010 +0200

    Add a comment about incrementing library version string
    
    Signed-off-by: JiÅ?í Techet <techet gmail com>

 configure.ac |   11 +++++++++--
 1 files changed, 9 insertions(+), 2 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index a5c5f37..390c8e9 100644
--- a/configure.ac
+++ b/configure.ac
@@ -7,7 +7,6 @@ m4_define([champlain_version],
           [champlain_major_version.champlain_minor_version.champlain_micro_version])
 m4_define([champlain_api_version],
           [champlain_major_version.champlain_minor_version])
-# if the API changes, set to 0
 AC_PREREQ(2.61)
 AC_INIT([libchamplain],
         [champlain_version],
@@ -26,7 +25,13 @@ m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])])
 AC_PROG_CC
 AM_PROG_CC_C_O
 
-# Checks for libraries.
+# Before making a release, the LIBRARY_VERSION string should be modified.
+# The string is of the form C:R:A.
+# - If interfaces have been changed or added, but binary compatibility has
+#   been preserved, change to C+1:0:A+1
+# - If binary compatibility has been broken (eg removed or changed interfaces)
+#   change to C+1:0:0
+# - If the interface is the same as the previous version, change to C:R+1:A
 LIBRARY_VERSION=1:0:0
 CHAMPLAIN_API_VERSION=champlain_api_version
 CHAMPLAIN_API_VERSION_NORM=champlain_major_version[_]champlain_minor_version
@@ -45,6 +50,8 @@ AC_SUBST(CHAMPLAIN_MAJORMINOR)
 
 AC_SUBST(LIBRARY_VERSION)
 
+# Checks for libraries.
+
 PKG_CHECK_MODULES(DEPS,
   [   glib-2.0 >= 2.16
       gobject-2.0 >= 2.10



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]