Introduce soname to indicate ABI version of shared library

tobiasherzke · tobiasherzke · commit dee193347c9f · 2021-09-27T16:38:58.000+02:00
Having a "soname" that stays constant allows compiled executables that link against liblsl to continue to work whithout recompilation when liblsl is updated as long as the soname of liblsl stays the same. Each time the ABI of liblsl changes in future, the setting LSL_ABI_VERSION in CMakeLists.txt should be incremented by one to change the soname. Closes #140.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,6 +6,9 @@ project (liblsl
 	HOMEPAGE_URL "https://github.com/sccn/liblsl"
 	)
 
+# API version, to be incremented on backwards-incompatible ABI changes
+set(LSL_ABI_VERSION 2)
+
 set(CMAKE_CXX_VISIBILITY_PRESET hidden)
 set(CMAKE_VISIBILITY_INLINES_HIDDEN ON)
 if(NOT MSVC_VERSION VERSION_LESS 1700)
@@ -239,6 +242,7 @@ target_include_directories(lsl INTERFACE
 )
 set_target_properties(lsl PROPERTIES
 	VERSION ${liblsl_VERSION_MAJOR}.${liblsl_VERSION_MINOR}.${liblsl_VERSION_PATCH}
+	SOVERSION ${LSL_ABI_VERSION}
 )
 
 # enable some additional expensive compiler optimizations

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@ project (liblsl`
`6`	`6`	`HOMEPAGE_URL "https://github.com/sccn/liblsl"`
`7`	`7`	`)`
`8`	`8`
	`9`	`+# API version, to be incremented on backwards-incompatible ABI changes`
	`10`	`+set(LSL_ABI_VERSION 2)`
	`11`	`+`
`9`	`12`	`set(CMAKE_CXX_VISIBILITY_PRESET hidden)`
`10`	`13`	`set(CMAKE_VISIBILITY_INLINES_HIDDEN ON)`
`11`	`14`	`if(NOT MSVC_VERSION VERSION_LESS 1700)`
`@@ -239,6 +242,7 @@ target_include_directories(lsl INTERFACE`
`239`	`242`	`)`
`240`	`243`	`set_target_properties(lsl PROPERTIES`
`241`	`244`	`VERSION ${liblsl_VERSION_MAJOR}.${liblsl_VERSION_MINOR}.${liblsl_VERSION_PATCH}`
	`245`	`+ SOVERSION ${LSL_ABI_VERSION}`
`242`	`246`	`)`
`243`	`247`
`244`	`248`	`# enable some additional expensive compiler optimizations`