review updates

- install symlinks only for development (NAMELINK_COMPONENT) - make installation configurable - better formatting Co-authored-by: Pratik Nayak <[email protected]>
ginkgo-project · Dec 9, 2023 · 909999c · 909999c
1 parent 75777b4
commit 909999c
Show file tree

Hide file tree

Showing 2 changed files with 81 additions and 69 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -88,6 +88,7 @@ else()
 endif()
 option(GINKGO_BUILD_PAPI_SDE "Build Ginkgo with PAPI SDE. Enabled if a system installation is found." ${PAPI_SDE_FOUND})
 option(GINKGO_DPCPP_SINGLE_MODE "Do not compile double kernels for the DPC++ backend." OFF)
+option(GINKGO_INSTALL "Enable installation of Ginkgo" ON)
 option(GINKGO_INSTALL_RPATH "Set the RPATH when installing its libraries." ON)
 option(GINKGO_INSTALL_RPATH_ORIGIN "Add $ORIGIN (Linux) or @loader_path (MacOS) to the installation RPATH." ON)
 option(GINKGO_INSTALL_RPATH_DEPENDENCIES "Add dependencies to the installation RPATH." OFF)
@@ -442,53 +443,73 @@ ginkgo_modify_flags(CMAKE_CUDA_FLAGS_DEBUG)
 ginkgo_modify_flags(CMAKE_CUDA_FLAGS_RELEASE)
 ginkgo_install()
 
-set(GINKGO_TEST_INSTALL_SRC_DIR "${Ginkgo_SOURCE_DIR}/test/test_install/")
-set(GINKGO_TEST_INSTALL_BIN_DIR "${Ginkgo_BINARY_DIR}/test/test_install/")
-set(GINKGO_TEST_EXPORTBUILD_SRC_DIR "${Ginkgo_SOURCE_DIR}/test/test_exportbuild/")
-set(GINKGO_TEST_EXPORTBUILD_BIN_DIR "${Ginkgo_BINARY_DIR}/test/test_exportbuild/")
-set(GINKGO_TEST_PKGCONFIG_SRC_DIR "${Ginkgo_SOURCE_DIR}/test/test_pkgconfig/")
-set(GINKGO_TEST_PKGCONFIG_BIN_DIR "${Ginkgo_BINARY_DIR}/test/test_pkgconfig/")
-get_property(GINKGO_USE_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
-# GINKGO_CONFIG_PREFIX contains / in the end.
-set(GINKGO_CONFIG_PREFIX "$<$<BOOL:${GINKGO_USE_MULTI_CONFIG}>:$<CONFIG>/>")
-set(GINKGO_TEST_INSTALL_CMD ${GINKGO_TEST_INSTALL_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_install)
-set(GINKGO_TEST_EXPORTBUILD_CMD ${GINKGO_TEST_EXPORTBUILD_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_exportbuild)
-set(GINKGO_TEST_PKGCONFIG_CMD ${GINKGO_TEST_PKGCONFIG_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_pkgconfig)
-if(GINKGO_BUILD_CUDA)
-    set(GINKGO_TEST_INSTALL_CUDA_CMD ${GINKGO_TEST_INSTALL_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_install_cuda)
-endif()
-if(GINKGO_BUILD_HIP)
-    set(GINKGO_TEST_INSTALL_HIP_CMD ${GINKGO_TEST_INSTALL_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_install_hip)
-endif()
+if (GINKGO_INSTALL)
+    set(GINKGO_TEST_INSTALL_SRC_DIR "${Ginkgo_SOURCE_DIR}/test/test_install/")
+    set(GINKGO_TEST_INSTALL_BIN_DIR "${Ginkgo_BINARY_DIR}/test/test_install/")
+    set(GINKGO_TEST_EXPORTBUILD_SRC_DIR "${Ginkgo_SOURCE_DIR}/test/test_exportbuild/")
+    set(GINKGO_TEST_EXPORTBUILD_BIN_DIR "${Ginkgo_BINARY_DIR}/test/test_exportbuild/")
+    set(GINKGO_TEST_PKGCONFIG_SRC_DIR "${Ginkgo_SOURCE_DIR}/test/test_pkgconfig/")
+    set(GINKGO_TEST_PKGCONFIG_BIN_DIR "${Ginkgo_BINARY_DIR}/test/test_pkgconfig/")
+    get_property(GINKGO_USE_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
+    # GINKGO_CONFIG_PREFIX contains / in the end.
+    set(GINKGO_CONFIG_PREFIX "$<$<BOOL:${GINKGO_USE_MULTI_CONFIG}>:$<CONFIG>/>")
+    set(GINKGO_TEST_INSTALL_CMD ${GINKGO_TEST_INSTALL_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_install)
+    set(GINKGO_TEST_EXPORTBUILD_CMD ${GINKGO_TEST_EXPORTBUILD_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_exportbuild)
+    set(GINKGO_TEST_PKGCONFIG_CMD ${GINKGO_TEST_PKGCONFIG_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_pkgconfig)
+    if(GINKGO_BUILD_CUDA)
+        set(GINKGO_TEST_INSTALL_CUDA_CMD ${GINKGO_TEST_INSTALL_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_install_cuda)
+    endif()
+    if(GINKGO_BUILD_HIP)
+        set(GINKGO_TEST_INSTALL_HIP_CMD ${GINKGO_TEST_INSTALL_BIN_DIR}/${GINKGO_CONFIG_PREFIX}test_install_hip)
+    endif()
 
-file(MAKE_DIRECTORY "${GINKGO_TEST_INSTALL_BIN_DIR}")
-file(MAKE_DIRECTORY "${GINKGO_TEST_EXPORTBUILD_BIN_DIR}")
-set(TOOLSET "")
-if(NOT "${CMAKE_GENERATOR_TOOLSET}" STREQUAL "")
-    set(TOOLSET "-T${CMAKE_GENERATOR_TOOLSET}")
+    file(MAKE_DIRECTORY "${GINKGO_TEST_INSTALL_BIN_DIR}")
+    file(MAKE_DIRECTORY "${GINKGO_TEST_EXPORTBUILD_BIN_DIR}")
+    set(TOOLSET "")
+    if(NOT "${CMAKE_GENERATOR_TOOLSET}" STREQUAL "")
+        set(TOOLSET "-T${CMAKE_GENERATOR_TOOLSET}")
+    endif()
+    add_custom_target(test_install
+        COMMAND ${CMAKE_COMMAND} -G${CMAKE_GENERATOR} ${TOOLSET}
+        -S${GINKGO_TEST_INSTALL_SRC_DIR}
+        -B${GINKGO_TEST_INSTALL_BIN_DIR}
+        -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
+        -DCMAKE_PREFIX_PATH=${CMAKE_INSTALL_PREFIX}
+        -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
+        -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+        -DCMAKE_CUDA_COMPILER=${CMAKE_CUDA_COMPILER}
+        -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
+        # `--config cfg` is ignored by single-configuration generator.
+        # `$<CONFIG>` is always be the same as `CMAKE_BUILD_TYPE` in
+        # single-configuration generator.
+        COMMAND ${CMAKE_COMMAND}
+        --build ${GINKGO_TEST_INSTALL_BIN_DIR}
+        --config $<CONFIG>
+        COMMAND ${GINKGO_TEST_INSTALL_CMD}
+        COMMAND ${GINKGO_TEST_INSTALL_CUDA_CMD}
+        COMMAND ${GINKGO_TEST_INSTALL_HIP_CMD}
+        WORKING_DIRECTORY ${GINKGO_TEST_INSTALL_BIN_DIR}
+        COMMENT "Running a test on the installed binaries. "
+        "This requires running `(sudo) make install` first.")
+
+    add_custom_target(test_pkgconfig
+        COMMAND ${CMAKE_COMMAND} -G${CMAKE_GENERATOR} ${TOOLSET}
+        -S${GINKGO_TEST_PKGCONFIG_SRC_DIR}
+        -B${GINKGO_TEST_PKGCONFIG_BIN_DIR}
+        -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
+        -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+        -DCMAKE_CUDA_COMPILER=${CMAKE_CUDA_COMPILER}
+        -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
+        # `--config cfg` is ignored by single-configuration generator.
+        # `$<CONFIG>` is always be the same as `CMAKE_BUILD_TYPE` in
+        # single-configuration generator.
+        COMMAND ${CMAKE_COMMAND}
+        --build ${GINKGO_TEST_PKGCONFIG_BIN_DIR}
+        --config $<CONFIG>
+        COMMAND ${GINKGO_TEST_PKGCONFIG_CMD}
+        COMMENT "Running a test on Ginkgo's PkgConfig"
+        "This requires installing Ginkgo first")
 endif()
-add_custom_target(test_install
-    COMMAND ${CMAKE_COMMAND} -G${CMAKE_GENERATOR} ${TOOLSET}
-    -S${GINKGO_TEST_INSTALL_SRC_DIR}
-    -B${GINKGO_TEST_INSTALL_BIN_DIR}
-    -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-    -DCMAKE_PREFIX_PATH=${CMAKE_INSTALL_PREFIX}
-    -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-    -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-    -DCMAKE_CUDA_COMPILER=${CMAKE_CUDA_COMPILER}
-    -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
-    # `--config cfg` is ignored by single-configuration generator.
-    # `$<CONFIG>` is always be the same as `CMAKE_BUILD_TYPE` in
-    # single-configuration generator.
-    COMMAND ${CMAKE_COMMAND}
-    --build ${GINKGO_TEST_INSTALL_BIN_DIR}
-    --config $<CONFIG>
-    COMMAND ${GINKGO_TEST_INSTALL_CMD}
-    COMMAND ${GINKGO_TEST_INSTALL_CUDA_CMD}
-    COMMAND ${GINKGO_TEST_INSTALL_HIP_CMD}
-    WORKING_DIRECTORY ${GINKGO_TEST_INSTALL_BIN_DIR}
-    COMMENT "Running a test on the installed binaries. "
-    "This requires running `(sudo) make install` first.")
 
 add_custom_target(test_exportbuild
     COMMAND ${CMAKE_COMMAND} -G${CMAKE_GENERATOR} ${TOOLSET}
@@ -508,24 +529,6 @@ add_custom_target(test_exportbuild
     COMMENT "Running a test on Ginkgo's exported build directory. "
     "This requires compiling Ginkgo with `-DGINKGO_EXPORT_BUILD_DIR=ON` first.")
 
-add_custom_target(test_pkgconfig
-    COMMAND ${CMAKE_COMMAND} -G${CMAKE_GENERATOR} ${TOOLSET}
-    -S${GINKGO_TEST_PKGCONFIG_SRC_DIR}
-    -B${GINKGO_TEST_PKGCONFIG_BIN_DIR}
-    -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-    -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-    -DCMAKE_CUDA_COMPILER=${CMAKE_CUDA_COMPILER}
-    -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
-    # `--config cfg` is ignored by single-configuration generator.
-    # `$<CONFIG>` is always be the same as `CMAKE_BUILD_TYPE` in
-    # single-configuration generator.
-    COMMAND ${CMAKE_COMMAND}
-    --build ${GINKGO_TEST_PKGCONFIG_BIN_DIR}
-    --config $<CONFIG>
-    COMMAND ${GINKGO_TEST_PKGCONFIG_CMD}
-    COMMENT "Running a test on Ginkgo's PkgConfig"
-    "This requires installing Ginkgo first")
-
 
 # Setup CPack
 set(CPACK_PACKAGE_DESCRIPTION_FILE "${Ginkgo_SOURCE_DIR}/README.md")

diff --git a/cmake/install_helpers.cmake b/cmake/install_helpers.cmake
@@ -42,23 +42,32 @@ endfunction()
 # @param name  the name of the Ginkgo library target
 # @param ARGN  this should contain any external dependency's library PATH
 function(ginkgo_install_library name)
+    if(NOT GINKGO_INSTALL)
+        return()
+    endif()
+
     ginkgo_add_install_rpath("${name}" "${ARGN}")
 
     install(TARGETS "${name}"
         EXPORT Ginkgo
         LIBRARY
-        DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}"
-        COMPONENT Runtime
+            DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}"
+            COMPONENT Runtime
+            NAMELINK_COMPONENT Development
         RUNTIME
-        DESTINATION "${CMAKE_INSTALL_FULL_BINDIR}"
-        COMPONENT Runtime
+            DESTINATION "${CMAKE_INSTALL_FULL_BINDIR}"
+            COMPONENT Runtime
         ARCHIVE
-        DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}"
-        COMPONENT Development
+            DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}"
+            COMPONENT Development
         )
 endfunction()
 
 function(ginkgo_install)
+    if(NOT GINKGO_INSTALL)
+        return()
+    endif()
+
     # pkg-config file
     install(FILES ${Ginkgo_BINARY_DIR}/ginkgo_$<CONFIG>.pc
         DESTINATION "${GINKGO_INSTALL_PKGCONFIG_DIR}"