From 52976011e57a8ec6037a8f39b5b989f5f31b00dc Mon Sep 17 00:00:00 2001
From: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
Date: Sun, 6 Feb 2022 14:58:40 +0800
Subject: Implement library versioning for macOS

Currently, the Makefile provides no version information about library to
the macOS linker. This makes the linker fill in zeroes for
`compatibility_version` and `current_version` by default.

This is a problem for when you make breaking changes to the library that
require re-compilation of linked software. The new library will still
have a `compatibility_version` of `0.0.0`, which misleads the linker
into believing the new library is a drop-in replacement for the old one.

Let's fix that by making sure we pass version information correctly to
the linker on macOS.

NOTE: Since this increments the `compatibility_version` of the DSO from
`0.0.0` to `1.0.0`, this change will require re-compilation of any macOS
software that dynamically link against `libkeccak`. If you'd like to
avoid this inconvenience for your users, you may wish to wait until you
decide to increment `LIB_MAJOR` or otherwise make breaking changes to
`libkeccak` before merging this change.
---
 macos.mk | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'macos.mk')

diff --git a/macos.mk b/macos.mk
index b475197..c7e7c28 100644
--- a/macos.mk
+++ b/macos.mk
@@ -1,5 +1,5 @@
 LIBEXT = dylib
-LIBFLAGS = -dynamiclib
+LIBFLAGS = -dynamiclib -Wl,-compatibility_version,$(LIB_MAJOR) -Wl,-current_version,$(LIB_VERSION)
 
 LIBMAJOREXT = $(LIB_MAJOR).$(LIBEXT)
 LIBMINOREXT = $(LIB_VERSION).$(LIBEXT)
-- 
cgit v1.2.3-70-g09d2