lib: Switch to a 3-part version number for the library interface.

With a carefully documented description of how to increment the
various version components.

diff --git a/Makefile.local b/Makefile.local
index 9b7423edf524b9059a2b229c51031461b6859f07..32b8f4a8ec09dc3d61278087bb631541ab30b071 100644 (file)
--- a/Makefile.local
+++ b/Makefile.local
@@ -107,7 +107,7 @@ notmuch_client_srcs =               \
 
 notmuch_client_modules = $(notmuch_client_srcs:.c=.o)
 notmuch: $(notmuch_client_modules) lib/libnotmuch.so
 
 notmuch_client_modules = $(notmuch_client_srcs:.c=.o)
 notmuch: $(notmuch_client_modules) lib/libnotmuch.so

-       $(call quiet,CC,$(LDFLAGS)) -Llib -lnotmuch $(filter-out lib/libnotmuch.so,$^) $(FINAL_LDFLAGS) -o $@
+       $(call quiet,CC,$(LDFLAGS)) -Llib -lnotmuch $(notmuch_client_modules) $(FINAL_LDFLAGS) -o $@

 
 notmuch.1.gz: notmuch.1
        $(call quiet,gzip) --stdout $^ > $@
 
 notmuch.1.gz: notmuch.1
        $(call quiet,gzip) --stdout $^ > $@

diff --git a/lib/Makefile.local b/lib/Makefile.local
index 0463c93a57f07faf49aff67e6cb3b084ae8270da..0fd843a14296e74700ee8a6351c2431bd2f98368 100644 (file)
--- a/lib/Makefile.local
+++ b/lib/Makefile.local
@@ -1,4 +1,21 @@
-SONAME = libnotmuch.so.1
+# The major version of the library interface. This will control the soname.
+# As such, this number must be incremented for any incompatible change to
+# the library interface, (such as the deletion of an API or a major
+# semantic change that breaks formerly functioning code).
+LIBNOTMUCH_VERSION_MAJOR = 1
+
+# The minor version of the library interface. This should be incremented at
+# the time of release for any additions to the library interface.
+LIBNOTMUCH_VERSION_MINOR = 0
+
+# The release version the library interface. This should be incremented at
+# the time of release if there have been no changes to the interface, (but
+# simply compatible changes to the implementation).
+LIBNOTMUCH_VERSION_RELEASE = 0
+
+LINKER_NAME = libnotmuch.so
+SONAME = $(LINKER_NAME).$(LIBNOTMUCH_VERSION_MAJOR)
+LIBNAME = $(SONAME).$(LIBNOTMUCH_VERSION_MINOR).$(LIBNOTMUCH_VERSION_RELEASE)

 
 dir := lib
 extra_cflags += -I$(dir) -fPIC
 
 dir := lib
 extra_cflags += -I$(dir) -fPIC


@@ -21,19 +38,23 @@ libnotmuch_cxx_srcs =               \
 
 libnotmuch_modules = $(libnotmuch_c_srcs:.c=.o) $(libnotmuch_cxx_srcs:.cc=.o)
 
 
 libnotmuch_modules = $(libnotmuch_c_srcs:.c=.o) $(libnotmuch_cxx_srcs:.cc=.o)
 

-$(dir)/$(SONAME) : $(libnotmuch_modules)
+$(dir)/$(LIBNAME) : $(libnotmuch_modules)

        $(call quiet,CXX,$(LDFLAGS)) $^ $(FINAL_LDFLAGS) -shared -Wl,-soname=$(SONAME) -o $@
 
        $(call quiet,CXX,$(LDFLAGS)) $^ $(FINAL_LDFLAGS) -shared -Wl,-soname=$(SONAME) -o $@
 

-$(dir)/libnotmuch.so: $(dir)/$(SONAME)
-       $(call quiet_symlink, $(SONAME) $@)
+$(dir)/$(SONAME): $(dir)/$(LIBNAME)
+       $(call quiet_symlink, $(LIBNAME) $@)
+
+$(dir)/$(LINKER_NAME): $(dir)/$(SONAME)
+       $(call quiet_symlink, $(LIBNAME) $@)

 
 install: install-$(dir)
 
 install-$(dir):
        $(call quiet_mkdir, $(DESTDIR)$(libdir)/)
 
 install: install-$(dir)
 
 install-$(dir):
        $(call quiet_mkdir, $(DESTDIR)$(libdir)/)

-       $(call quiet_install_data, $(dir)/$(SONAME) $(DESTDIR)$(libdir)/)
+       $(call quiet_install_data, $(dir)/$(LIBNAME) $(DESTDIR)$(libdir)/)
+       $(call quiet_symlink, $(LIBNAME) $(DESTDIR)$(libdir)/$(SONAME))
+       $(call quiet_symlink, $(LIBNAME) $(DESTDIR)$(libdir)/$(LINKER_NAME))

        $(call quiet_install_data, $(dir)/notmuch.h $(DESTDIR)$(prefix)/include/)
        $(call quiet_install_data, $(dir)/notmuch.h $(DESTDIR)$(prefix)/include/)

-       $(call quiet_symlink, $(SONAME) $(DESTDIR)$(libdir)/libnotmuch.so)

 
 SRCS  := $(SRCS) $(libnotmuch_c_srcs) $(libnotmuch_cxx_srcs)
 
 SRCS  := $(SRCS) $(libnotmuch_c_srcs) $(libnotmuch_cxx_srcs)

-CLEAN := $(CLEAN) $(libnotmuch_modules) $(dir)/$(SONAME) $(dir)/libnotmuch.so *.so
+CLEAN := $(CLEAN) $(libnotmuch_modules) $(dir)/$(SONAME) $(dir)/$(LINKER_NAME) $(dir)$(LIBNAME)