[PTI-SDK] Increment Version and set SOVERSION (#35)

* Increment SDK version to 0.2.0
* Add minor version to SOVERSION/SONAME to denote compatibility between
  versions. This will eventually change back to major version after
  `>= 1.0.0` release.
* Added warnings for when this eventually changes back.

Signed-off-by: Schilling, Matthew <[email protected]>

Author: mschilling0

sdk/CMakeLists.txt

@@ -61,6 +61,9 @@ set(PTI_INSTALL_CMAKE_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/pti")
 set(PTI_INSTALL_INCLUDE_DIR "${CMAKE_INSTALL_INCLUDEDIR}/pti")
 set(PTI_INSTALL_LIB_DIR "${CMAKE_INSTALL_LIBDIR}")
 set(PTI_INSTALL_BIN_DIR "${CMAKE_INSTALL_BINDIR}")
+set(PTI_API_SOVERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}")
+
+CheckSOVersion(${PTI_API_SOVERSION})
 
 set(PTI_COMPILE_FLAGS_EXPR
     $<$<CXX_COMPILER_ID:IntelLLVM>:-Wall
@@ -129,7 +132,7 @@ target_include_directories(
 set_target_properties(
   pti
   PROPERTIES VERSION "${PROJECT_VERSION}"
-             SOVERSION "${PROJECT_VERSION_MAJOR}"
+             SOVERSION "${PTI_API_SOVERSION}"
              POSITION_INDEPENDENT_CODE ON)
 
 target_compile_options(pti PRIVATE ${PTI_COMPILE_FLAGS_EXPR})
@@ -154,7 +157,7 @@ target_include_directories(
 set_target_properties(
   pti_view
   PROPERTIES VERSION "${PROJECT_VERSION}"
-             SOVERSION "${PROJECT_VERSION_MAJOR}"
+             SOVERSION "${PTI_API_SOVERSION}"
              POSITION_INDEPENDENT_CODE ON)
 
 target_compile_options(pti_view PRIVATE ${PTI_COMPILE_FLAGS_EXPR})

sdk/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

sdk/cmake/Modules/macros.cmake

@@ -713,7 +713,7 @@ macro(GetGTPinUtil TARGET UTIL)
     add_custom_command(OUTPUT "${GTPIN_UTIL_PATH}/GTPIN/utils/${UTIL}.h"
                               "${GTPIN_UTIL_PATH}/GTPIN/utils/${UTIL}.cpp"
                       COMMAND "${PYTHON_EXECUTABLE}" "${PTI_CMAKE_MACRO_DIR}/get_gtpin_util.py" ${GTPIN_UTIL_PATH} ${CMAKE_BINARY_DIR} ${UTIL})
-    target_sources(${TARGET} PRIVATE 
+    target_sources(${TARGET} PRIVATE
       "${GTPIN_UTIL_PATH}/Examples/utils/${UTIL}.cpp")
     target_include_directories(${TARGET}
       PUBLIC "${GTPIN_UTIL_PATH}/GTPIN/utils")
@@ -728,7 +728,7 @@ macro(FindGTPinUtil TARGET UTIL)
       NAMES ${UTIL}.cpp
       PATHS "${GTPIN_PATH}/Examples/utils")
     if(GTPIN_${UTIL}_PATH)
-      target_sources(${TARGET} PRIVATE 
+      target_sources(${TARGET} PRIVATE
         ${GTPIN_${UTIL}_PATH})
       target_include_directories(${TARGET}
         PUBLIC "${GTPIN_PATH}/Examples/utils")
@@ -1042,3 +1042,25 @@ macro(GetGTest)
                                                 "${EXTRA_COMPILE_OPTIONS}")
   endif()
 endmacro()
+
+macro(CheckSOVersion PROJ_SOVERSION)
+  # Not automatically set because this should be done intentionally.
+  # PTI's rules for backwords compatibility should be re-evaluated upon first
+  # major / production release.
+  # PTI is following [semver](https://semver.org/) versioning and we are using
+  # the SOVERSION to denote backword compatibility.
+  if ("${PROJECT_VERSION}" VERSION_GREATER_EQUAL "1.0.0")
+    if("${PROJ_SOVERSION}" STREQUAL "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}")
+      message(AUTHOR_WARNING "${PROJECT_NAME} currently has the SOVERSION: "
+                    "${PROJ_SOVERSION}. After the first major release, ${PROJECT_NAME}"
+                    " should have the SOVERSION: ${PROJECT_VERSION_MAJOR}.")
+    endif()
+  else()
+    if("${PROJ_SOVERSION}" STREQUAL "${PROJECT_VERSION_MAJOR}")
+      message(AUTHOR_WARNING "${PROJECT_NAME} currently has the SOVERSION: "
+                    "${PROJ_SOVERSION}. During development, ${PROJECT_NAME}"
+                    " should have the SOVERSION:"
+                    " ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.")
+    endif()
+  endif()
+endmacro()