Rename CMake package to ROCmCMakeBuildTools (#128)

Having the name of this CMake package be ROCM is consistently confusing to users who expect find_package(ROCM [...]) to add ROCm packages to their build, instead of tools that we use to build ROCm (see #49). Renaming the CMake project to ROCmCMakeBuildTools makes the purpose of this package clearer. In order to have as smooth a transition as possible, starting this as a notice, will make into a deprecation/warning in ~6.2, error sometime later, remove in 7.0.
ROCm · Oct 11, 2023 · df4df6d · df4df6d
1 parent 433d5cb
commit df4df6d
Show file tree

Hide file tree

Showing 42 changed files with 150 additions and 38 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,10 @@
 # Change Log for rocm-cmake
 
 ## [rocm-cmake 0.10.0 for ROCm 5.7.0]
+
+### Changed
+- Rename CMake package to ROCmCMakeBuildTools
+  - Deprecate use of ROCM package name, redirects to ROCmCMakeBuildTools for backwards compatibility
 ### Added
 - Added ROCMTest module
 - ROCMCreatePackage: Added support for ASAN packages

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -9,18 +9,21 @@ set(CMAKE_INSTALL_PREFIX "/opt/rocm" CACHE PATH "")
 project(rocm-cmake LANGUAGES NONE)
 
 install(DIRECTORY share DESTINATION .)
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/ROCMConfigVersion.cmake DESTINATION share/rocm/cmake)
+install(
+    FILES ${CMAKE_CURRENT_BINARY_DIR}/ROCmCMakeBuildToolsConfigVersion.cmake
+    DESTINATION share/rocmcmakebuildtools/cmake
+)
 
 set(CPACK_RPM_PACKAGE_LICENSE "MIT")
 
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/share/rocm/cmake)
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/share/rocmcmakebuildtools/cmake)
 include(ROCMCreatePackage)
 include(ROCMSetupVersion)
 
 rocm_setup_version(VERSION 0.10.0)
 
 include(CMakePackageConfigHelpers)
-write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/ROCMConfigVersion.cmake
+write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/ROCmCMakeBuildToolsConfigVersion.cmake
     COMPATIBILITY SameMajorVersion)
 
 rocm_create_package(
@@ -41,4 +44,3 @@ enable_testing()
 add_custom_target(check COMMAND ${CMAKE_CTEST_COMMAND} --output-on-failure -C ${CMAKE_CFG_INTDIR})
 add_subdirectory(test)
 add_subdirectory(doc)
-
diff --git a/share/rocm/cmake/ROCMConfig.cmake b/share/rocm/cmake/ROCMConfig.cmake
@@ -1,6 +1,8 @@
 # ######################################################################################################################
-# Copyright (C) 2017 Advanced Micro Devices, Inc.
+# Copyright (C) 2023 Advanced Micro Devices, Inc.
 # ######################################################################################################################
 
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR})
-include(ROCMChecks)
+message(STATUS
+    "Use of find_package(ROCM) will be deprecated soon, please switch to find_package(ROCmCMakeBuildTools)."
+)
+find_package(ROCmCMakeBuildTools HINTS "${CMAKE_CURRENT_LIST_DIR}")
diff --git a/share/rocm/cmake/ROCMConfigVersion.cmake b/share/rocm/cmake/ROCMConfigVersion.cmake
@@ -0,0 +1,7 @@
+# ######################################################################################################################
+# Copyright (C) 2023 Advanced Micro Devices, Inc.
+# ######################################################################################################################
+
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/../../rocmcmakebuildtools/cmake)
+
+include(ROCmCMakeBuildToolsConfigVersion)
diff --git a/share/rocm/cmake/ROCMAnalyzers.cmake → ...cmakebuildtools/cmake/ROCMAnalyzers.cmake b/share/rocm/cmake/ROCMAnalyzers.cmake → ...cmakebuildtools/cmake/ROCMAnalyzers.cmake
diff --git a/share/rocm/cmake/ROCMCheckTargetIds.cmake → ...buildtools/cmake/ROCMCheckTargetIds.cmake b/share/rocm/cmake/ROCMCheckTargetIds.cmake → ...buildtools/cmake/ROCMCheckTargetIds.cmake
diff --git a/share/rocm/cmake/ROCMChecks.cmake → ...ocmcmakebuildtools/cmake/ROCMChecks.cmake b/share/rocm/cmake/ROCMChecks.cmake → ...ocmcmakebuildtools/cmake/ROCMChecks.cmake
diff --git a/share/rocm/cmake/ROCMClangTidy.cmake → ...cmakebuildtools/cmake/ROCMClangTidy.cmake b/share/rocm/cmake/ROCMClangTidy.cmake → ...cmakebuildtools/cmake/ROCMClangTidy.cmake
diff --git a/share/rocm/cmake/ROCMClients.cmake → ...cmcmakebuildtools/cmake/ROCMClients.cmake b/share/rocm/cmake/ROCMClients.cmake → ...cmcmakebuildtools/cmake/ROCMClients.cmake
diff --git a/share/rocm/cmake/ROCMCppCheck.cmake → ...mcmakebuildtools/cmake/ROCMCppCheck.cmake b/share/rocm/cmake/ROCMCppCheck.cmake → ...mcmakebuildtools/cmake/ROCMCppCheck.cmake
diff --git a/share/rocm/cmake/ROCMCreatePackage.cmake → ...ebuildtools/cmake/ROCMCreatePackage.cmake b/share/rocm/cmake/ROCMCreatePackage.cmake → ...ebuildtools/cmake/ROCMCreatePackage.cmake
diff --git a/share/rocm/cmake/ROCMDocs.cmake → .../rocmcmakebuildtools/cmake/ROCMDocs.cmake b/share/rocm/cmake/ROCMDocs.cmake → .../rocmcmakebuildtools/cmake/ROCMDocs.cmake
diff --git a/share/rocm/cmake/ROCMDoxygenDoc.cmake → ...makebuildtools/cmake/ROCMDoxygenDoc.cmake b/share/rocm/cmake/ROCMDoxygenDoc.cmake → ...makebuildtools/cmake/ROCMDoxygenDoc.cmake
diff --git a/share/rocm/cmake/ROCMHeaderWrapper.cmake → ...ebuildtools/cmake/ROCMHeaderWrapper.cmake b/share/rocm/cmake/ROCMHeaderWrapper.cmake → ...ebuildtools/cmake/ROCMHeaderWrapper.cmake
diff --git a/share/rocm/cmake/ROCMInstallSymlinks.cmake → ...uildtools/cmake/ROCMInstallSymlinks.cmake b/share/rocm/cmake/ROCMInstallSymlinks.cmake → ...uildtools/cmake/ROCMInstallSymlinks.cmake
diff --git a/share/rocm/cmake/ROCMInstallTargets.cmake → ...buildtools/cmake/ROCMInstallTargets.cmake b/share/rocm/cmake/ROCMInstallTargets.cmake → ...buildtools/cmake/ROCMInstallTargets.cmake
diff --git a/...rocm/cmake/ROCMPackageConfigHelpers.cmake → ...ools/cmake/ROCMPackageConfigHelpers.cmake b/...rocm/cmake/ROCMPackageConfigHelpers.cmake → ...ools/cmake/ROCMPackageConfigHelpers.cmake
diff --git a/share/rocm/cmake/ROCMProperty.cmake → ...mcmakebuildtools/cmake/ROCMProperty.cmake b/share/rocm/cmake/ROCMProperty.cmake → ...mcmakebuildtools/cmake/ROCMProperty.cmake
diff --git a/share/rocm/cmake/ROCMSetupVersion.cmake → ...kebuildtools/cmake/ROCMSetupVersion.cmake b/share/rocm/cmake/ROCMSetupVersion.cmake → ...kebuildtools/cmake/ROCMSetupVersion.cmake
diff --git a/share/rocm/cmake/ROCMSphinxDoc.cmake → ...cmakebuildtools/cmake/ROCMSphinxDoc.cmake b/share/rocm/cmake/ROCMSphinxDoc.cmake → ...cmakebuildtools/cmake/ROCMSphinxDoc.cmake
diff --git a/share/rocm/cmake/ROCMTest.cmake → .../rocmcmakebuildtools/cmake/ROCMTest.cmake b/share/rocm/cmake/ROCMTest.cmake → .../rocmcmakebuildtools/cmake/ROCMTest.cmake
diff --git a/share/rocm/cmake/ROCMUtilities.cmake → ...cmakebuildtools/cmake/ROCMUtilities.cmake b/share/rocm/cmake/ROCMUtilities.cmake → ...cmakebuildtools/cmake/ROCMUtilities.cmake
diff --git a/share/rocmcmakebuildtools/cmake/ROCmCMakeBuildToolsConfig.cmake b/share/rocmcmakebuildtools/cmake/ROCmCMakeBuildToolsConfig.cmake
@@ -0,0 +1,6 @@
+# ######################################################################################################################
+# Copyright (C) 2017 Advanced Micro Devices, Inc.
+# ######################################################################################################################
+
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR})
+include(ROCMChecks)
diff --git a/share/rocm/cmake/header_template.h.in → ...makebuildtools/cmake/header_template.h.in b/share/rocm/cmake/header_template.h.in → ...makebuildtools/cmake/header_template.h.in
diff --git a/test/analyze/CMakeLists.txt b/test/analyze/CMakeLists.txt
@@ -6,7 +6,7 @@
 cmake_minimum_required (VERSION 3.5)
 project(simple LANGUAGES CXX)
 
-find_package(ROCM)
+find_package(ROCmCMakeBuildTools)
 
 include(ROCMInstallTargets)
 include(ROCMAnalyzers)
@@ -15,7 +15,7 @@ include(ROCMSetupVersion)
 include(ROCMClangTidy)
 rocm_enable_clang_tidy(
     DEV_WARNINGS_AS_ERRORS
-    CHECKS 
+    CHECKS
         *
         -llvmlibc-*
     ERRORS
@@ -26,10 +26,10 @@ rocm_enable_clang_tidy(
 include(ROCMCppCheck)
 rocm_enable_cppcheck(
     INCONCLUSIVE
-    CHECKS 
+    CHECKS
         warning
     FORCE
-    SUPPRESS 
+    SUPPRESS
         unmatchedSuppression
     SOURCES
         simple.cpp

diff --git a/test/docsphinx/CMakeLists.txt b/test/docsphinx/CMakeLists.txt
@@ -7,7 +7,7 @@ project(useful LANGUAGES CXX)
 # Ideally should be NONE, but GNUInstallDirs detects platform arch using try_compile
 # https://stackoverflow.com/questions/43379311/why-does-project-affect-cmakes-opinion-on-cmake-sizeof-void-p
 
-find_package(ROCM)
+find_package(ROCmCMakeBuildTools)
 
 include(ROCMSphinxDoc)
 include(GNUInstallDirs)

diff --git a/test/libbasic/CMakeLists.txt b/test/libbasic/CMakeLists.txt
@@ -6,7 +6,7 @@
 cmake_minimum_required (VERSION 3.5)
 project(basic CXX)
 
-find_package(ROCM)
+find_package(ROCmCMakeBuildTools)
 find_package(simple)
 
 include(ROCMInstallTargets)

diff --git a/test/libheaderonly/CMakeLists.txt b/test/libheaderonly/CMakeLists.txt
@@ -6,7 +6,7 @@
 cmake_minimum_required (VERSION 3.5)
 project(headeronly LANGUAGES NONE)
 
-find_package(ROCM)
+find_package(ROCmCMakeBuildTools)
 
 include(ROCMInstallTargets)
 include(ROCMPackageConfigHelpers)
@@ -18,15 +18,15 @@ rocm_setup_version(VERSION 1.0.0)
 
 if(ROCM_PREFIX)
 rocm_create_package(
-    NAME headeronly 
+    NAME headeronly
     PREFIX ${ROCM_PREFIX}
     MAINTAINER "Amd [email protected]"
     PTH
     LDCONFIG
     HEADER_ONLY)
 else()
 rocm_create_package(
-    NAME headeronly 
+    NAME headeronly
     MAINTAINER "Amd [email protected]"
     PTH
     LDCONFIG
@@ -38,15 +38,15 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/lib)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin)
 
 add_library(headeronly INTERFACE)
-target_include_directories(headeronly 
-    INTERFACE 
+target_include_directories(headeronly
+    INTERFACE
         $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
         $<INSTALL_INTERFACE:headeronly/include/>)
 
 if(ROCM_PREFIX)
     rocm_install_targets(
-        TARGETS headeronly 
-        INCLUDE include 
+        TARGETS headeronly
+        INCLUDE include
         PREFIX ${ROCM_PREFIX})
     rocm_install(
         DIRECTORY
@@ -58,8 +58,8 @@ if(ROCM_PREFIX)
         PERMISSIONS OWNER_WRITE OWNER_READ GROUP_READ WORLD_READ
     )
     rocm_export_targets(
-        TARGETS headeronly 
-        INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/importtarget.cmake 
+        TARGETS headeronly
+        INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/importtarget.cmake
         PREFIX ${ROCM_PREFIX})
     rocm_install_symlink_subdir(${ROCM_PREFIX})
 else()
@@ -76,6 +76,6 @@ else()
         PERMISSIONS OWNER_WRITE OWNER_READ GROUP_READ WORLD_READ
     )
     rocm_export_targets(
-        TARGETS headeronly 
+        TARGETS headeronly
         INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/importtarget.cmake)
 endif()
diff --git a/test/libsimple/CMakeLists.txt b/test/libsimple/CMakeLists.txt
@@ -6,7 +6,7 @@
 cmake_minimum_required (VERSION 3.5)
 project(simple CXX)
 
-find_package(ROCM)
+find_package(ROCmCMakeBuildTools)
 
 include(ROCMInstallTargets)
 include(ROCMPackageConfigHelpers)
@@ -18,14 +18,14 @@ rocm_setup_version(VERSION 1.0.0)
 
 if(ROCM_PREFIX)
 rocm_create_package(
-    NAME simple 
+    NAME simple
     PREFIX ${ROCM_PREFIX}
     MAINTAINER "Amd [email protected]"
     PTH
     LDCONFIG)
 else()
 rocm_create_package(
-    NAME simple 
+    NAME simple
     MAINTAINER "Amd [email protected]"
     PTH
     LDCONFIG)

diff --git a/test/libsimple2/CMakeLists.txt b/test/libsimple2/CMakeLists.txt
@@ -6,7 +6,7 @@
 cmake_minimum_required (VERSION 3.5)
 project(simple2 CXX)
 
-find_package(ROCM)
+find_package(ROCmCMakeBuildTools)
 
 include(ROCMInstallTargets)
 include(ROCMPackageConfigHelpers)
@@ -20,13 +20,13 @@ rocm_setup_version(VERSION 1.0.0)
 
 if(ROCM_PREFIX)
 rocm_create_package(
-    NAME simple2 
+    NAME simple2
     PREFIX ${ROCM_PREFIX}
     MAINTAINER "Amd [email protected]"
     LDCONFIG)
 else()
 rocm_create_package(
-    NAME simple2 
+    NAME simple2
     MAINTAINER "Amd [email protected]"
     LDCONFIG)
 endif()

diff --git a/test/libsimplecompat/CMakeLists.txt b/test/libsimplecompat/CMakeLists.txt
@@ -0,0 +1,51 @@
+################################################################################
+# Copyright (C) 2017 Advanced Micro Devices, Inc.
+################################################################################
+
+
+cmake_minimum_required (VERSION 3.5)
+project(simple CXX)
+
+find_package(ROCM)
+
+include(ROCMInstallTargets)
+include(ROCMPackageConfigHelpers)
+include(ROCMSetupVersion)
+include(ROCMInstallSymlinks)
+include(ROCMCreatePackage)
+
+rocm_setup_version(VERSION 1.0.0)
+
+if(ROCM_PREFIX)
+rocm_create_package(
+    NAME simple
+    PREFIX ${ROCM_PREFIX}
+    MAINTAINER "Amd [email protected]"
+    PTH
+    LDCONFIG)
+else()
+rocm_create_package(
+    NAME simple
+    MAINTAINER "Amd [email protected]"
+    PTH
+    LDCONFIG)
+endif()
+
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/lib)
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/lib)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin)
+
+add_library(simple simple.cpp)
+rocm_set_soversion(simple 1.1.2)
+
+add_executable(simple-main main.cpp)
+target_link_libraries(simple-main simple)
+
+if(ROCM_PREFIX)
+    rocm_install_targets(TARGETS simple simple-main INCLUDE include PREFIX ${ROCM_PREFIX})
+    rocm_export_targets(TARGETS simple INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/importtarget.cmake PREFIX ${ROCM_PREFIX})
+    rocm_install_symlink_subdir(${ROCM_PREFIX})
+else()
+    rocm_install_targets(TARGETS simple simple-main INCLUDE include)
+    rocm_export_targets(TARGETS simple INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/importtarget.cmake)
+endif()
diff --git a/test/libsimplecompat/LICENSE b/test/libsimplecompat/LICENSE
@@ -0,0 +1,3 @@
+This is a placeholder license file for the purposes of testing, and is not the license for this repository or the files
+contained in this directory. The license for rocm-cmake (including all files in this directory) can be located at 
+"https://github.com/RadeonOpenCompute/rocm-cmake/blob/master/LICENSE".
diff --git a/test/libsimplecompat/importtarget.cmake b/test/libsimplecompat/importtarget.cmake
@@ -0,0 +1,3 @@
+# ######################################################################################################################
+# Copyright (C) 2017 Advanced Micro Devices, Inc.
+# ######################################################################################################################
diff --git a/test/libsimplecompat/include/simple.h b/test/libsimplecompat/include/simple.h
@@ -0,0 +1,12 @@
+/*******************************************************************************
+ * Copyright (C) 2017 Advanced Micro Devices, Inc.
+ ******************************************************************************/
+
+
+#ifndef GUARD_SIMPLE_H
+#define GUARD_SIMPLE_H
+
+void simple();
+
+
+#endif
diff --git a/test/libsimplecompat/main.cpp b/test/libsimplecompat/main.cpp
@@ -0,0 +1,6 @@
+
+void simple();
+
+int main() {
+    simple();
+}
diff --git a/test/libsimplecompat/simple.cpp b/test/libsimplecompat/simple.cpp
@@ -0,0 +1,7 @@
+/*******************************************************************************
+ * Copyright (C) 2017 Advanced Micro Devices, Inc.
+ ******************************************************************************/
+
+
+void simple()
+{}
diff --git a/test/libsimpletest/CMakeLists.txt b/test/libsimpletest/CMakeLists.txt
@@ -6,7 +6,7 @@
 cmake_minimum_required (VERSION 3.5)
 project(simple CXX)
 
-find_package(ROCM)
+find_package(ROCmCMakeBuildTools)
 
 include(ROCMInstallTargets)
 include(ROCMPackageConfigHelpers)
@@ -20,7 +20,7 @@ rocm_setup_version(VERSION 1.0.0)
 rocm_enable_test_package(simple)
 
 rocm_create_package(
-    NAME simple 
+    NAME simple
     MAINTAINER "Amd [email protected]"
     PTH
     LDCONFIG)

diff --git a/test/libwrapper/CMakeLists.txt b/test/libwrapper/CMakeLists.txt
@@ -6,7 +6,7 @@
 cmake_minimum_required (VERSION 3.5)
 project(test-wrapper CXX)
 
-find_package(ROCM)
+find_package(ROCmCMakeBuildTools)
 
 include(ROCMInstallTargets)
 include(ROCMPackageConfigHelpers)
@@ -19,14 +19,14 @@ rocm_setup_version(VERSION 1.0.0)
 
 if(ROCM_PREFIX)
 rocm_create_package(
-    NAME wrapper 
+    NAME wrapper
     PREFIX ${ROCM_PREFIX}
     MAINTAINER "Amd [email protected]"
     PTH
     LDCONFIG)
 else()
 rocm_create_package(
-    NAME wrapper 
+    NAME wrapper
     MAINTAINER "Amd [email protected]"
     PTH
     LDCONFIG)

diff --git a/test/pass/rename-compatibility.cmake b/test/pass/rename-compatibility.cmake
@@ -0,0 +1,9 @@
+# ######################################################################################################################
+# Copyright (C) 2023 Advanced Micro Devices, Inc.
+# ######################################################################################################################
+
+install_dir(${TEST_DIR}/libsimplecompat TARGETS package)
+test_check_package(
+    NAME simple
+    HEADER simple.h
+    TARGET simple)
diff --git a/test/test.cmake b/test/test.cmake
@@ -92,7 +92,7 @@ macro(test_exec)
 endmacro()
 
 macro(use_rocm_cmake)
-    list(APPEND CMAKE_MODULE_PATH ${PREFIX}/share/rocm/cmake)
+    list(APPEND CMAKE_MODULE_PATH ${PREFIX}/share/rocmcmakebuildtools/cmake)
 endmacro()
 
 function(configure_dir DIR)

diff --git a/test/toolchain-var/CMakeLists.txt b/test/toolchain-var/CMakeLists.txt
@@ -4,7 +4,7 @@
 
 
 cmake_minimum_required (VERSION 3.5)
-find_package(ROCM)
+find_package(ROCmCMakeBuildTools)
 project(toolchain-var CXX)
 
 if(CHANGE_TOOLCHAIN)