From f2ab08652e9875150eca646c9e6cf881f2db0367 Mon Sep 17 00:00:00 2001 From: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com> Date: Wed, 29 May 2024 15:44:10 -0400 Subject: [PATCH] Update env.rst syntax (#95) * Update env.rst syntax * Update env.rst corrected HIP_PLATFORM example --------- Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com> --- amd/hipcc/docs/env.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/amd/hipcc/docs/env.rst b/amd/hipcc/docs/env.rst index 6829f62ee18902..1a2940d82531b5 100644 --- a/amd/hipcc/docs/env.rst +++ b/amd/hipcc/docs/env.rst @@ -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.