Skip to content

Commit

Permalink
doc update for HIPCC Perl scripts
Browse files Browse the repository at this point in the history
  ROCDOC-994 - HIPCC - perl clarifications

Change-Id: I5ad15a6ad8af2054c7f600fe5fdb0738136e1373
  • Loading branch information
David Salinas authored and David Salinas committed Nov 20, 2024
1 parent 981d7f0 commit 0366005
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions amd/hipcc/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@
HIPCC documentation
******************************************

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

There are both Perl and C++ executable versions of the ``hipcc`` and ``hipconfig`` compiler driver utilities provided. By default the C++ version is used when ``hipcc`` is run. To enable the Perl versions of these commands set the environment variable ``HIP_USE_PERL_SCRIPTS=1``.
There are both C++ and Perl executable versions of the ``hipcc`` and ``hipconfig`` compiler driver utilities provided. By default the C++ version is used when ``hipcc`` is run.

.. note::
You can manually run the Perl scripts using hipcc.pl and hipconfig.pl from the installation. However, you must ensure Perl is installed on the system for the scripts to work. Perl is not automatically installed with the ROCm installation.

The documentation is structured as follows:

Expand Down

0 comments on commit 0366005

Please sign in to comment.