Skip to content

Commit

Permalink
Update env.rst syntax (#95)
Browse files Browse the repository at this point in the history
* Update env.rst syntax

* Update env.rst

corrected HIP_PLATFORM example

---------

Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
  • Loading branch information
yhuiYH and randyh62 authored May 29, 2024
1 parent a9dbcc5 commit f2ab086
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions amd/hipcc/docs/env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
HIPCC environment variables
******************************************

The environment variable ``HIP_PLATFORM`` can be used to specify ``amd`` or ``nvidia`` depending on the available backend tool flows:
The environment variable ``HIP_PLATFORM`` can be used to specify ``amd`` or ``nvidia`` depending on the available backend tool flows. For example:

* ``HIP_PLATFORM``='amd' or ``HIP_PLATFORM``='nvidia'.
.. code-block:: shell
export HIP_PLATFORM=amd
.. note::
If ``HIP_PLATFORM`` is not set, then ``hipcc`` will attempt to auto-detect based on if the ``nvcc`` tool is found.
Expand Down

0 comments on commit f2ab086

Please sign in to comment.