From 1c3335abf1273b3ac8fc7463369107bff8e2dd31 Mon Sep 17 00:00:00 2001 From: Evgeny Mankov Date: Thu, 1 Feb 2024 15:09:26 +0000 Subject: [PATCH] [HIPIFY][doc] `Cmake` -> `CMake` --- docs/hipify-clang.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/hipify-clang.md b/docs/hipify-clang.md index 10bb6f61..6c592b77 100644 --- a/docs/hipify-clang.md +++ b/docs/hipify-clang.md @@ -201,7 +201,7 @@ After applying all the matchers, the output HIP source is produced. In most cases, you can get a suitable version of `LLVM+CLANG` with your package manager. Failing that or having multiple versions of `LLVM`, you can [download a release archive](http://releases.llvm.org/), build or install it, and set -[CMAKE_PREFIX_PATH](https://cmake.org/cmake/help/v3.5/variable/CMAKE_PREFIX_PATH.html) so `Cmake` can find it; for instance: `-DCMAKE_PREFIX_PATH=D:\LLVM\17.0.6\dist` +[CMAKE_PREFIX_PATH](https://cmake.org/cmake/help/v3.5/variable/CMAKE_PREFIX_PATH.html) so `CMake` can find it; for instance: `-DCMAKE_PREFIX_PATH=D:\LLVM\17.0.6\dist` ## hipify-clang: usage @@ -229,7 +229,7 @@ For some hipification automation (starting from clang 8.0.0), it is also possibl -p= ``` -The compilation database should be provided in the `compile_commands.json` file or generated by clang based on Cmake; options separator `'--'` must not be used. +The compilation database should be provided in the `compile_commands.json` file or generated by clang based on CMake; options separator `'--'` must not be used. For a list of `hipify-clang` options, run `hipify-clang --help`. @@ -248,7 +248,7 @@ cmake \ make -j install ``` -On Windows, the following option should be specified for `Cmake` in the first place: `-G "Visual Studio 17 2022"`; the generated `hipify-clang.sln` should be built by `Visual Studio 17 2022` instead of `make.` +On Windows, the following option should be specified for `CMake` in the first place: `-G "Visual Studio 17 2022"`; the generated `hipify-clang.sln` should be built by `Visual Studio 17 2022` instead of `make.` Please, see [hipify-clang: Windows](#windows) for the supported tools for building. Debug build type `-DCMAKE_BUILD_TYPE=Debug` is also supported and tested; `LLVM+CLANG` should be built in `Debug` mode as well. @@ -422,11 +422,11 @@ Ubuntu 22-23: LLVM 13.0.0 - 17.0.6, CUDA 7.0 - 12.3.2, cuDNN 8.0.5 - 8.9.7 Minimum build system requirements for the above configurations: -Cmake 3.16.8, GNU C/C++ 9.2, Python 2.7. +CMake 3.16.8, GNU C/C++ 9.2, Python 2.7. Recommended build system requirements: -Cmake 3.28.1, GNU C/C++ 13.2, Python 3.11.6. +CMake 3.28.1, GNU C/C++ 13.2, Python 3.11.6. Here is an example of building `hipify-clang` with testing support on `Ubuntu 23.10.01`: @@ -519,7 +519,7 @@ Total Discovered Tests: 102 *Tested configurations:* -| **LLVM** | **CUDA** | **cuDNN** | **Visual Studio (latest)** | **Cmake** | **Python** | +| **LLVM** | **CUDA** | **cuDNN** | **Visual Studio (latest)** | **CMake** | **Python** | |----------------:|-------------:|---------------:|------------------------------------------:|----------------:|--------------:| | 4.0.0 - 5.0.2 | 7.0 - 8.0 | 5.1.10 - 7.1.4 | 2015.14.0, 2017.15.5.2 | 3.5.1 - 3.18.0 | 3.6.4 - 3.8.5 | | 6.0.0 - 6.0.1 | 7.0 - 9.0 | 7.0.5 - 7.6.5 | 2015.14.0, 2017.15.5.5 | 3.6.0 - 3.18.0 | 3.7.2 - 3.8.5 | @@ -536,7 +536,7 @@ Total Discovered Tests: 102 | 19.0.0git | 7.0 - 12.3.2 | 8.0.5 - 8.9.7 | 2019.16.11.32, 2022.17.8.3 | 3.28.1 | 3.12.1 | `*` LLVM 14.x.x is the latest major release supporting Visual Studio 2017. -To build LLVM 14.x.x correctly by Visual Studio 2017, `-DLLVM_FORCE_USE_OLD_TOOLCHAIN=ON` should be added to a corresponding Cmake command line. +To build LLVM 14.x.x correctly by Visual Studio 2017, `-DLLVM_FORCE_USE_OLD_TOOLCHAIN=ON` should be added to a corresponding CMake command line. LLVM < 14.x.x can be built correctly by Visual Studio 2017 without the `LLVM_FORCE_USE_OLD_TOOLCHAIN` option. `**` Note that LLVM 17.0.0 was withdrawn due to an issue, please use 17.0.1 or newer instead.