Skip to content

Commit

Permalink
Minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
neon60 committed Dec 16, 2024
1 parent f45fe58 commit c604f44
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/install/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Installation
* :doc:`rocm-install-on-linux:index`
* :doc:`rocm-install-on-windows:index`

By default, HIP is installed into ``/opt/rocm/hip``.
By default, HIP is installed into ``/opt/rocm``.

.. note::
There is no autodetection for the HIP installation. If you choose to install it somewhere other than the default location, you must set the ``HIP_PATH`` environment variable as explained in `Build HIP from source <./build.html>`_.
Expand Down Expand Up @@ -92,7 +92,7 @@ Installation
The default paths are:
* CUDA SDK: ``/usr/local/cuda``
* HIP: ``/opt/rocm/hip``
* HIP: ``/opt/rocm``

#. Set the HIP_PLATFORM to nvidia.

Expand Down
1 change: 1 addition & 0 deletions docs/reference/hip_runtime_api/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,6 @@ The API is organized into modules based on functionality.
* :ref:`runtime_compilation_reference`
* :ref:`callback_activity_apis_reference`
* :ref:`graph_management_reference`
* :ref:`opengl_interoperability_reference`
* :ref:`graphics_interoperability_reference`
* :ref:`cooperative_groups_reference`
12 changes: 12 additions & 0 deletions docs/reference/hip_runtime_api/modules/opengl_interoperability.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. meta::
:description: The OpenGL interoperability reference page.
:keywords: AMD, ROCm, HIP, CUDA, OpenGL interoperability, OpenGL interop

.. _opengl_interoperability_reference:

*******************************************************************************
OpenGL interoperability
*******************************************************************************

.. doxygengroup:: GL
:content-only:
1 change: 1 addition & 0 deletions docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ subtrees:
- file: reference/hip_runtime_api/modules/runtime_compilation
- file: reference/hip_runtime_api/modules/callback_activity_apis
- file: reference/hip_runtime_api/modules/graph_management
- file: reference/hip_runtime_api/modules/opengl_interoperability
- file: reference/hip_runtime_api/modules/graphics_interoperability
- file: reference/hip_runtime_api/modules/cooperative_groups_reference
- file: reference/hip_runtime_api/global_defines_enums_structs_files
Expand Down
8 changes: 4 additions & 4 deletions docs/understand/amd_clr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Project organization

CLR includes the following source code,

* ``hipamd`` - contains implementation of ``HIP`` language on the AMD platform. It is hosted at `clr/hipamd <https://github.com/ROCm/clr/tree/develop/hipamd>`_.
* ``hipamd`` - contains implementation of ``HIP`` language on the AMD platform. It is hosted at `clr/hipamd <https://github.com/ROCm/clr/tree/amd-staging/hipamd>`_.

* ``opencl`` - contains implementation of `OpenCL™ <https://www.khronos.org/opencl/>`_ on AMD platform. It is hosted at `clr/opencl <https://github.com/ROCm/clr/tree/develop/opencl>`_.
* ``opencl`` - contains implementation of `OpenCL™ <https://www.khronos.org/opencl/>`_ on AMD platform. It is hosted at `clr/opencl <https://github.com/ROCm/clr/tree/amd-staging/opencl>`_.

* ``rocclr`` - contains ROCm compute runtime used in `HIP` and `OpenCL™`. This is hosted at `clr/rocclr <https://github.com/ROCm/clr/tree/develop/rocclr>`_.
* ``rocclr`` - contains ROCm compute runtime used in `HIP` and `OpenCL™`. This is hosted at `clr/rocclr <https://github.com/ROCm/clr/tree/amd-staging/rocclr>`_.


How to build/install
Expand Down Expand Up @@ -79,4 +79,4 @@ To run ``hip-tests`` please go to the repository and follow the steps.
Release notes
-------------

HIP provides release notes in CLR `change log <https://github.com/ROCm/clr/blob/develop/CHANGELOG.md>`_, which has records of changes in each release.
HIP provides release notes in CLR `change log <https://github.com/ROCm/clr/blob/amd-staging/CHANGELOG.md>`_, which has records of changes in each release.

0 comments on commit c604f44

Please sign in to comment.