From 41ef5aa33ae09d1b1258c339f3f40cb821f56485 Mon Sep 17 00:00:00 2001 From: Istvan Kiss Date: Sun, 15 Dec 2024 19:09:18 +0100 Subject: [PATCH] Minor fixes --- docs/install/install.rst | 4 ++-- docs/reference/hip_runtime_api/modules.rst | 1 + .../modules/opengl_interoperability.rst | 12 ++++++++++++ docs/sphinx/_toc.yml.in | 1 + docs/understand/amd_clr.rst | 8 ++++---- 5 files changed, 20 insertions(+), 6 deletions(-) create mode 100644 docs/reference/hip_runtime_api/modules/opengl_interoperability.rst diff --git a/docs/install/install.rst b/docs/install/install.rst index a5b174a1dd..75161a44a7 100644 --- a/docs/install/install.rst +++ b/docs/install/install.rst @@ -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>`_. @@ -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. diff --git a/docs/reference/hip_runtime_api/modules.rst b/docs/reference/hip_runtime_api/modules.rst index 9a976ac9e8..375d1abcd7 100644 --- a/docs/reference/hip_runtime_api/modules.rst +++ b/docs/reference/hip_runtime_api/modules.rst @@ -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` diff --git a/docs/reference/hip_runtime_api/modules/opengl_interoperability.rst b/docs/reference/hip_runtime_api/modules/opengl_interoperability.rst new file mode 100644 index 0000000000..2d11df922e --- /dev/null +++ b/docs/reference/hip_runtime_api/modules/opengl_interoperability.rst @@ -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: \ No newline at end of file diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 5d69918b99..674ed7b72a 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -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 diff --git a/docs/understand/amd_clr.rst b/docs/understand/amd_clr.rst index eca39270cd..bcefb68359 100644 --- a/docs/understand/amd_clr.rst +++ b/docs/understand/amd_clr.rst @@ -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 `_. +* ``hipamd`` - contains implementation of ``HIP`` language on the AMD platform. It is hosted at `clr/hipamd `_. -* ``opencl`` - contains implementation of `OpenCL™ `_ on AMD platform. It is hosted at `clr/opencl `_. +* ``opencl`` - contains implementation of `OpenCL™ `_ on AMD platform. It is hosted at `clr/opencl `_. -* ``rocclr`` - contains ROCm compute runtime used in `HIP` and `OpenCL™`. This is hosted at `clr/rocclr `_. +* ``rocclr`` - contains ROCm compute runtime used in `HIP` and `OpenCL™`. This is hosted at `clr/rocclr `_. How to build/install @@ -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 `_, which has records of changes in each release. +HIP provides release notes in CLR `change log `_, which has records of changes in each release.