Skip to content

Commit

Permalink
[HIPIFY][doc] cmake -> Cmake
Browse files Browse the repository at this point in the history
  • Loading branch information
emankov committed Feb 1, 2024
1 parent 514f53e commit 5eba418
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/hipify-clang.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

## <a name="hipify-clang-usage"></a>hipify-clang: usage

Expand Down Expand Up @@ -229,7 +229,7 @@ For some hipification automation (starting from clang 8.0.0), it is also possibl
-p=<folder containing compile_commands.json>
```

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`.

Expand All @@ -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.
Expand Down Expand Up @@ -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`:

Expand Down Expand Up @@ -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 |
Expand All @@ -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.
Expand Down

0 comments on commit 5eba418

Please sign in to comment.