ROCm CMake Build Tools

Applies to Linux and Windows

2024-02-21

3 min read time

Summary

ROCm CMake Build Tools (also stylized as “ROCmCMakeBuildTools” and previously known as “rocm-cmake”) is a collection of functions that unify and simplify the CMake code of the ROCm components, as well as ensuring consistency across these components.

Usage

The ROCm CMake Build Tools are primarily used at build time of a library, and as such are not runtime dependencies for any generated libraries, packages, or executables.

The tools can be included into a CMake project by running:

find_package(ROCmCMakeBuildTools)
# or
find_package(ROCM) # deprecated, but included for backwards compatibility

Once the tools have been included in this manner, individual files may be included by running include(<file_name>). The file names, and the functions, variables, and macros accessible using each file are listed below.

Files & Contents

• ROCMAnalyzers

  • rocm_mark_as_analyzer

  • ROCM_ENABLE_GH_ANNOTATIONS

• ROCMCheckTargetIds

  • rocm_check_target_ids

• ROCMClangTidy

  • rocm_enable_clang_tidy

  • rocm_clang_tidy_check

  • CLANG_TIDY_EXE

  • CLANG_TIDY_CACHE

  • CLANG_TIDY_CACHE_SIZE

  • CLANG_TIDY_DEPEND_ON_TARGET

• ROCMClients

  • rocm_package_setup_client_component

• ROCMCppCheck

  • rocm_enable_cppcheck

  • CPPCHECK_EXE

  • CPPCHECK_BUILD_DIR

• ROCMCreatePackage

  • rocm_create_package

  • rocm_package_add_rpm_dependencies

  • rocm_package_add_deb_dependencies

  • rocm_package_add_dependencies

  • rocm_package_setup_component

• ROCMDocs

  • rocm_mark_as_doc

  • rocm_clean_doc_output

• ROCMDoxygenDoc

  • rocm_add_doxygen_doc

  • DOXYGEN_EXECUTABLE

  • DOT_EXECUTABLE

• ROCMInstallSymlinks

  • rocm_install_symlink_subdir

• ROCMInstallTargets

  • rocm_install

  • rocm_install_targets

  • rocm_export_targets

• ROCMPackageConfigHelpers

  • rocm_configure_package_config_file

• ROCMSetupVersion

  • rocm_get_version

  • rocm_setup_version

• ROCMSphinxDoc

  • rocm_add_doxygen_doc

  • SPHINX_EXECUTABLE

  • SPHINX_${BUILDER}_DIR

• ROCMTest

  • rocm_enable_test_package

  • rocm_add_test

  • rocm_add_test_executable

  • rocm_test_header

  • rocm_test_headers

  • rocm_install_test

  • rocm_mark_as_test

  • rocm_link_test_dependencies

  • rocm_test_link_libraries

  • CTEST_PARALLEL_LEVEL

  • CTEST_TIMEOUT

  • ROCM_TEST_GDB

• ROCMUtilities

  • rocm_join_if_set

  • rocm_defer

  • rocm_find_program_version

Indices and tables

• Index

• Search Page