Skip to content

Commit 7020840

Browse files
committed
Update HIPCC environment variables page
1 parent ec3ccf1 commit 7020840

File tree

1 file changed

+48
-17
lines changed

1 file changed

+48
-17
lines changed

amd/hipcc/docs/env.rst

Lines changed: 48 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,58 @@
88
HIPCC environment variables
99
******************************************
1010

11-
The environment variable ``HIP_PLATFORM`` can be used to specify ``amd`` or ``nvidia`` depending on the available backend tool flows:
11+
This topic provides descriptions of the HIPCC environment
12+
variables. For more information about other ROCm environment variables, see
13+
:ref:`ROCm environment variables page <env-variables-reference>`.
1214

13-
* ``HIP_PLATFORM`` = ``amd`` or ``HIP_PLATFORM`` = ``nvidia``
15+
.. list-table::
16+
:header-rows: 1
17+
:widths: 50,50
1418

15-
.. note::
16-
If ``HIP_PLATFORM`` is not set, then ``hipcc`` will attempt to auto-detect based on if the ``nvcc`` tool is found.
19+
* - Environment variable
20+
- Value
1721

18-
Additional environment variable controls:
22+
* - | ``HIP_PLATFORM``
23+
| The platform targeted by HIP. If ``HIP_PLATFORM`` isn't set, then :doc:`HIPCC <hipcc:index>` attempts to auto-detect the platform based on whether the ``nvcc`` tool is found.
24+
- ``amd``, ``nvidia``
1925

20-
* ``CUDA_PATH`` : Path to the CUDA SDK. The default is ``/usr/local/cuda``. This is only used for NVIDIA platforms.
21-
* ``HIPCC_COMPILE_FLAGS_APPEND`` : Append extra flags as compilation options to ``hipcc``.
22-
* ``HIPCC_LINK_FLAGS_APPEND`` : Append extra flags as linking options to ``hipcc``.
23-
* ``HIPCC_VERBOSE`` : Outputs detailed information on subcommands executed during compilation.
26+
* - | ``HIP_PATH``
27+
| The path of the HIP SDK on Microsoft Windows for AMD platforms.
28+
- Default: ``C:/hip``
2429

25-
- ``HIPCC_VERBOSE = 1``: Displays the command to ``clang++`` or ``nvcc`` with all options (`hipcc-cmd`).
26-
- ``HIPCC_VERBOSE = 2``: Displays all relevant environment variables and their values.
27-
- ``HIPCC_VERBOSE = 4``: Displays only the arguments passed to the ``hipcc`` command (`hipcc_args`).
28-
- ``HIPCC_VERBOSE = 5``: Displays both the command to ``clang++`` or ``nvcc`` and ``hipcc`` arguments (`hipcc-cmd` and `hipcc-args`).
29-
- ``HIPCC_VERBOSE = 6``: Displays all relevant environment variables and their values, along with the arguments to the ``hipcc`` command.
30-
- ``HIPCC_VERBOSE = 7``: Displays all of the above: `hipcc-cmd`, `hipcc-args`, and environment variables.
31-
32-
30+
* - | ``ROCM_PATH``
31+
| The path of the installed ROCm software stack on Linux for AMD platforms.
32+
- Default: ``/opt/rocm``
3333

34+
* - | ``CUDA_PATH``
35+
| Path to the CUDA SDK, which is only used for NVIDIA platforms.
36+
- Default: ``/usr/local/cuda``
3437

38+
* - | ``HIP_CLANG_PATH``
39+
| Path to the clang, which is only used for AMD platforms.
40+
- Default: ``ROCM_PATH/llvm/bin`` or ``HIP_PATH/../llvm/bin"``
41+
42+
* - | ``HIP_LIB_PATH``
43+
| The HIP device library installation path.
44+
- Default: ``HIP_PATH/lib``
45+
46+
* - | ``HIP_DEVICE_LIB_PATH``
47+
| The HIP device library installation path.
48+
-
49+
50+
* - | ``HIPCC_COMPILE_FLAGS_APPEND``
51+
| Append extra flags as compilation options to ``hipcc``.
52+
-
53+
54+
* - | ``HIPCC_LINK_FLAGS_APPEND``
55+
| Append extra flags as compilation options to ``hipcc``.
56+
-
57+
58+
* - | ``HIPCC_VERBOSE``
59+
| Outputs detailed information on subcommands executed during compilation.
60+
- | 1: Displays the command to ``clang++`` or ``nvcc`` with all options (``hipcc-cmd``).
61+
| 2: Displays all relevant environment variables and their values.
62+
| 4: Displays only the arguments passed to the ``hipcc`` command (``hipcc_args``).
63+
| 5: Displays both the command to ``clang++`` or ``nvcc`` and ``hipcc`` arguments (``hipcc-cmd`` and ``hipcc-args``).
64+
| 6: Displays all relevant environment variables and their values, along with the arguments to the ``hipcc`` command.
65+
| 7: Displays all of the above: ``hipcc-cmd``, ``hipcc-args``, and environment variables.

0 commit comments

Comments
 (0)