|
5 | 5 | <!-- toc -->
|
6 | 6 |
|
7 | 7 | - [hipcc](#hipcc)
|
8 |
| - * [Documentation](#documentation) |
9 |
| - * [Environment Variables](#envVar) |
10 |
| - * [Usage](#hipcc-usage) |
11 |
| - * [Building](#building) |
12 |
| - * [Testing](#testing) |
| 8 | + - [Documentation](#documentation) |
| 9 | + - [Environment Variables](#envVar) |
| 10 | + - [Usage](#usage) |
| 11 | + - [Building](#building) |
| 12 | + - [Testing](#testing) |
13 | 13 |
|
14 | 14 | <!-- tocstop -->
|
15 | 15 |
|
16 | 16 | ## <a name="hipcc"></a> hipcc
|
17 | 17 |
|
18 |
| -`hipcc` is a compiler driver utility that will call clang or nvcc, depending on target, and pass the appropriate include and library options for the target compiler and HIP infrastructure. Historically, `hipcc` was provided as a script in the HIP repo ( https://github.com/ROCm-Developer-Tools/HIP/blob/main/bin/hipcc ). The `hipcc` provided in this project provides the same functionality, but is a binary rather than a script. At some point in the future, the hipcc script will be deprecated and ultimately removed from the HIP repo. |
| 18 | +`hipcc` is a compiler driver utility that will call clang or nvcc, depending on target, and pass the appropriate include and library options for the target compiler and HIP infrastructure. Historically, `hipcc` was provided as a script in the HIP repo [https://github.com/ROCm-Developer-Tools/HIP/blob/main/bin/hipcc](https://github.com/ROCm-Developer-Tools/HIP/blob/main/bin/hipcc). The `hipcc` provided in this project provides the same functionality, but is a binary rather than a script. At some point in the future, the hipcc script will be deprecated and ultimately removed from the HIP repo. |
19 | 19 |
|
20 | 20 | `hipcc` will pass-through options to the target compiler. The tools calling hipcc must ensure the compiler options are appropriate for the target compiler.
|
21 | 21 |
|
22 | 22 | ## Documentation
|
23 | 23 |
|
24 | 24 | Run the steps below to build documentation locally.
|
25 | 25 |
|
26 |
| -``` |
| 26 | +```shell |
27 | 27 | cd docs
|
28 | 28 |
|
29 |
| -pip3 install -r .sphinx/requirements.txt |
| 29 | +pip3 install -r sphinx/requirements.txt |
30 | 30 |
|
31 | 31 | python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
|
32 | 32 | ```
|
33 | 33 |
|
34 | 34 | ### <a name="envVar"></a> Environment Variables
|
35 | 35 |
|
36 | 36 | The environment variable HIP_PLATFORM may be used to specify amd/nvidia:
|
| 37 | + |
37 | 38 | - HIP_PLATFORM='amd' or HIP_PLATFORM='nvidia'.
|
38 | 39 | - If HIP_PLATFORM is not set, then hipcc will attempt to auto-detect based on if nvcc is found.
|
39 | 40 |
|
40 | 41 | Other environment variable controls:
|
| 42 | + |
41 | 43 | - HIP_PATH : Path to HIP directory, default is one dir level above location of hipcc.
|
42 | 44 | - CUDA_PATH : Path to CUDA SDK (default /usr/local/cuda). Used on NVIDIA platforms only.
|
43 | 45 | - HSA_PATH : Path to HSA dir (defaults to ../../hsa relative to abs_path of hipcc). Used on AMD platforms only.
|
|
0 commit comments