Skip to content

Commit 44cd7a3

Browse files
randyh62neon60
authored andcommitted
Move reference/env_variables folder under docs/reference
Update conf.py Update exclude_patterns in conf.py for relocated env_variables include files Update debugging.rst Correct include-table for ./reference/env_variables/debug_hip_env.rst Update memory_management_hip_env.rst replace hip:hip-memory-coherence-table with coheence-control
1 parent 48666fd commit 44cd7a3

File tree

11 files changed

+20
-20
lines changed

11 files changed

+20
-20
lines changed

docs/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@
5454
numfig = False
5555

5656
exclude_patterns = [
57-
"doxygen/mainpage.md",
58-
"understand/glossary.md",
59-
'how-to/debugging_env.rst',
60-
"data/reference/env_variables"
57+
"./doxygen/mainpage.md",
58+
"./understand/glossary.md",
59+
'./how-to/debugging_env.rst',
60+
"./reference/env_variables"
6161
]
6262

6363
git_url = subprocess.check_output(['git', 'config', '--get', 'remote.origin.url']).strip().decode('ascii')
6464
if git_url.find("git:") != -1:
65-
html_theme_options = {"repository_url": "https://github.com/ROCm/hip"}
65+
html_theme_options = {"repository_url": "https://github.com/ROCm/hip"}

docs/faq.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ for the full list.
4040
What NVIDIA CUDA features does HIP support?
4141
-------------------------------------------
4242

43-
The :doc:`NVIDIA CUDA runtime API supported by HIP<hipify:tables/CUDA_Runtime_API_functions_supported_by_HIP>`
44-
and :doc:`NVIDIA CUDA driver API supported by HIP<hipify:tables/CUDA_Driver_API_functions_supported_by_HIP>`
43+
The :doc:`NVIDIA CUDA runtime API supported by HIP<hipify:reference/tables/CUDA_Runtime_API_functions_supported_by_HIP>`
44+
and :doc:`NVIDIA CUDA driver API supported by HIP<hipify:reference/tables/CUDA_Driver_API_functions_supported_by_HIP>`
4545
pages describe which NVIDIA CUDA APIs are supported and what the equivalents are.
46-
The :doc:`HIP API documentation <reference/hip_runtime_api_reference>` describes each API and
46+
The :ref:`HIP runtime API reference<runtime_api_reference>` describes each API and
4747
its limitations, if any, compared with the equivalent CUDA API.
4848

4949
The kernel language features are documented in the

docs/how-to/debugging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ HIP environment variable summary
273273

274274
Here are some of the more commonly used environment variables:
275275

276-
.. include-table:: data/reference/env_variables/debug_hip_env.rst
276+
.. include-table:: ./reference/env_variables/debug_hip_env.rst
277277
:table: hip-env-debug
278278

279279
General debugging tips

docs/how-to/hip_porting_guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,16 @@ HIPIFY
4646
translate CUDA to HIP code. There are two flavours available, ``hipfiy-clang``
4747
and ``hipify-perl``.
4848

49-
:doc:`hipify-clang <hipify:hipify-clang>` is, as the name implies, a Clang-based
49+
:doc:`hipify-clang <hipify:how-to/hipify-clang>` is, as the name implies, a Clang-based
5050
tool, and actually parses the code, translates it into an Abstract Syntax Tree,
5151
from which it then generates the HIP source. For this, ``hipify-clang`` needs to
5252
be able to actually compile the code, so the CUDA code needs to be correct, and
5353
a CUDA install with all necessary headers must be provided.
5454

55-
:doc:`hipify-perl <hipify:hipify-perl>` uses pattern matching, to translate the
55+
:doc:`hipify-perl <hipify:how-to/hipify-perl>` uses pattern matching, to translate the
5656
CUDA code to HIP. It does not require a working CUDA installation, and can also
5757
convert CUDA code, that is not syntactically correct. It is therefore easier to
58-
set up and use, but is not as powerful as ``hipfiy-clang``.
58+
set up and use, but is not as powerful as ``hipify-clang``.
5959

6060
Scanning existing CUDA code to scope the porting effort
6161
--------------------------------------------------------------------------------

docs/how-to/hip_runtime_api/asynchronous.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ developer may have to reduce the block size of the kernels. The kernel runtimes
8888
can be misleading for concurrent kernel runs, that is why during optimization
8989
it is a good practice to check the trace files, to see if one kernel is blocking
9090
another kernel, while they are running in parallel. For more information about
91-
the application tracing, check::doc:`rocprofiler:/how-to/using-rocprof`.
91+
application tracing, see :doc:`rocprofiler:how-to/using-rocprof`.
9292

9393
When running kernels in parallel, the execution time can increase due to
9494
contention for shared resources. This is because multiple kernels may attempt

docs/reference/env_variables.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@ on AMD platform, which are grouped by functionality.
1212
GPU isolation variables
1313
================================================================================
1414

15-
.. include:: ../data/reference/env_variables/gpu_isolation_hip_env.rst
15+
.. include:: ./env_variables/gpu_isolation_hip_env.rst
1616

1717
Profiling variables
1818
================================================================================
1919

20-
.. include:: ../data/reference/env_variables/profiling_hip_env.rst
20+
.. include:: ./env_variables/profiling_hip_env.rst
2121

2222
Debug variables
2323
================================================================================
2424

25-
.. include:: ../data/reference/env_variables/debug_hip_env.rst
25+
.. include:: ./env_variables/debug_hip_env.rst
2626

2727
Memory management related variables
2828
================================================================================
2929

30-
.. include:: ../data/reference/env_variables/memory_management_hip_env.rst
30+
.. include:: ./env_variables/memory_management_hip_env.rst
3131

3232
Other useful variables
3333
================================================================================
3434

35-
.. include:: ../data/reference/env_variables/miscellaneous_hip_env.rst
35+
.. include:: ./env_variables/miscellaneous_hip_env.rst
File renamed without changes.
File renamed without changes.

docs/data/reference/env_variables/memory_management_hip_env.rst renamed to docs/reference/env_variables/memory_management_hip_env.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ The memory management related environment variables in HIP are collected in the
22
following table. The ``HIP_HOST_COHERENT`` variable linked at the following
33
pages:
44

5-
- :ref:`Coherence control <hip:hip-memory-coherence-table>`
5+
- :ref:`Coherence control <coherence_control>`
66

7-
- :ref:`Memory allocation flags <hip:memory_allocation_flags>`
7+
- :ref:`Memory allocation flags <memory_allocation_flags>`
88

99
.. _hip-env-memory:
1010
.. list-table::
File renamed without changes.

0 commit comments

Comments
 (0)