|
4 | 4 | contain the root `toctree` directive. |
5 | 5 | .. highlight:: cmake |
6 | 6 |
|
7 | | -ROCm CMake Build Tools |
8 | | -====================== |
| 7 | +.. meta:: |
| 8 | + :description: ROCm CMake |
| 9 | + :keywords: ROCm, Cmake, library, api, AMD |
9 | 10 |
|
10 | | -Summary |
11 | | -------- |
| 11 | +.. _rocm-cmake: |
12 | 12 |
|
13 | | -ROCm CMake Build Tools (also stylized as "ROCmCMakeBuildTools" and previously |
14 | | -known as "rocm-cmake") is a collection of functions that unify and simplify the |
15 | | -CMake code of the ROCm components, as well as ensuring consistency across these |
16 | | -components. |
| 13 | +**************************************************** |
| 14 | +ROCm CMake build tools |
| 15 | +**************************************************** |
17 | 16 |
|
18 | | -Usage |
19 | | ------ |
| 17 | +ROCm CMake build tools (also known as "rocm-cmake") is a collection of functions |
| 18 | +that unify and simplify the CMake code of ROCm components, as well as ensuring |
| 19 | +consistency across these different components. The ROCm CMake build tools are used |
| 20 | +when building and developing many AMD ROCm libraries, but are not runtime dependencies |
| 21 | +for any libraries, packages or executables. |
20 | 22 |
|
21 | | -The ROCm CMake Build Tools are primarily used at build time of a library, and |
22 | | -as such are not runtime dependencies for any generated libraries, packages, |
23 | | -or executables. |
| 23 | +.. important:: |
| 24 | + ROCm CMake tools are not required when building or compiling an application that uses ROCm or HIP components. |
24 | 25 |
|
25 | | -The tools can be included into a CMake project by running:: |
| 26 | +The build tools can be included into a CMake project by running: |
| 27 | + |
| 28 | +.. code-block:: shell |
26 | 29 |
|
27 | 30 | find_package(ROCmCMakeBuildTools) |
28 | 31 | # or |
29 | 32 | find_package(ROCM) # deprecated, but included for backwards compatibility |
30 | 33 |
|
31 | 34 | Once the tools have been included in this manner, individual files may be |
32 | | -included by running ``include(<file_name>)``. The file names, and the |
33 | | -functions, variables, and macros accessible using each file are listed below. |
34 | | - |
35 | | -Files & Contents |
36 | | -~~~~~~~~~~~~~~~~ |
| 35 | +included by running ``include(<file_name>)``. The file names, the |
| 36 | +functions, variables, and macros accessible using each file are described in |
| 37 | +this documentation. |
37 | 38 |
|
38 | | -- :any:`ROCMAnalyzers` |
39 | | - + :any:`rocm_mark_as_analyzer` |
40 | | - + :any:`ROCM_ENABLE_GH_ANNOTATIONS` |
41 | | -- :any:`ROCMCheckTargetIds` |
42 | | - + :any:`rocm_check_target_ids` |
43 | | -- :any:`ROCMClangTidy` |
44 | | - + :any:`rocm_enable_clang_tidy` |
45 | | - + :any:`rocm_clang_tidy_check` |
46 | | - + :any:`CLANG_TIDY_EXE` |
47 | | - + :any:`CLANG_TIDY_CACHE` |
48 | | - + :any:`CLANG_TIDY_CACHE_SIZE` |
49 | | - + :any:`CLANG_TIDY_DEPEND_ON_TARGET` |
50 | | -- :any:`ROCMClients` |
51 | | - + :any:`rocm_package_setup_client_component` |
52 | | -- :any:`ROCMCppCheck` |
53 | | - + :any:`rocm_enable_cppcheck` |
54 | | - + :any:`CPPCHECK_EXE` |
55 | | - + :any:`CPPCHECK_BUILD_DIR` |
56 | | -- :any:`ROCMCreatePackage` |
57 | | - + :any:`rocm_create_package` |
58 | | - + :any:`rocm_package_add_rpm_dependencies` |
59 | | - + :any:`rocm_package_add_deb_dependencies` |
60 | | - + :any:`rocm_package_add_dependencies` |
61 | | - + :any:`rocm_package_setup_component` |
62 | | -- :any:`ROCMDocs` |
63 | | - + :any:`rocm_mark_as_doc` |
64 | | - + :any:`rocm_clean_doc_output` |
65 | | -- :any:`ROCMDoxygenDoc` |
66 | | - + :any:`rocm_add_doxygen_doc` |
67 | | - + :any:`DOXYGEN_EXECUTABLE` |
68 | | - + :any:`DOT_EXECUTABLE` |
69 | | -- :any:`ROCMInstallSymlinks` |
70 | | - + :any:`rocm_install_symlink_subdir` |
71 | | -- :any:`ROCMInstallTargets` |
72 | | - + :any:`rocm_install` |
73 | | - + :any:`rocm_install_targets` |
74 | | - + :any:`rocm_export_targets` |
75 | | -- :any:`ROCMPackageConfigHelpers` |
76 | | - + :any:`rocm_configure_package_config_file` |
77 | | -- :any:`ROCMSetupVersion` |
78 | | - + :any:`rocm_get_version` |
79 | | - + :any:`rocm_setup_version` |
80 | | -- :any:`ROCMSphinxDoc` |
81 | | - + :any:`rocm_add_doxygen_doc` |
82 | | - + :any:`SPHINX_EXECUTABLE` |
83 | | - + :any:`SPHINX_${BUILDER}_DIR` |
84 | | -- :any:`ROCMTest` |
85 | | - + :any:`rocm_enable_test_package` |
86 | | - + :any:`rocm_add_test` |
87 | | - + :any:`rocm_add_test_executable` |
88 | | - + :any:`rocm_test_header` |
89 | | - + :any:`rocm_test_headers` |
90 | | - + :any:`rocm_install_test` |
91 | | - + :any:`rocm_mark_as_test` |
92 | | - + :any:`rocm_link_test_dependencies` |
93 | | - + :any:`rocm_test_link_libraries` |
94 | | - + :any:`CTEST_PARALLEL_LEVEL` |
95 | | - + :any:`CTEST_TIMEOUT` |
96 | | - + :any:`ROCM_TEST_GDB` |
97 | | -- :any:`ROCMUtilities` |
98 | | - + :any:`rocm_join_if_set` |
99 | | - + :any:`rocm_defer` |
100 | | - + :any:`rocm_find_program_version` |
| 39 | +You can access the build tools on the `ROCm CMake GitHub repository <https://github.com/ROCm/rocm-cmake>`_. |
| 40 | +For a complete listing of the features of ROCm CMake refer to :ref:`contents`. |
101 | 41 |
|
102 | | -Indices and tables |
103 | | -================== |
| 42 | +To contribute to the documentation, refer to |
| 43 | +`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_. |
104 | 44 |
|
105 | | -* :ref:`genindex` |
106 | | -* :ref:`search` |
| 45 | +You can find licensing information on the |
| 46 | +`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page. |
0 commit comments