From 12ff7f51856a66efcc6e54ee832b19c7bb648a6c Mon Sep 17 00:00:00 2001 From: Istvan Kiss Date: Tue, 10 Sep 2024 20:46:57 +0200 Subject: [PATCH] PR feedbacks --- .../hip_runtime_api/data_structures.rst | 13 +++++ .../hip_runtime_api/data_structures_list.rst | 4 ++ docs/reference/hip_runtime_api/files.rst | 14 ++++++ docs/reference/hip_runtime_api/files_list.rst | 2 + docs/reference/hip_runtime_api/modules.rst | 30 +----------- .../virtual_memory_reference.rst | 3 +- .../hip_runtime_api/modules_list.rst | 29 ++++++++++++ docs/reference/hip_runtime_api_reference.rst | 47 ++++--------------- docs/sphinx/_toc.yml.in | 17 +++++-- 9 files changed, 88 insertions(+), 71 deletions(-) create mode 100644 docs/reference/hip_runtime_api/data_structures.rst create mode 100644 docs/reference/hip_runtime_api/data_structures_list.rst create mode 100644 docs/reference/hip_runtime_api/files.rst create mode 100644 docs/reference/hip_runtime_api/files_list.rst create mode 100644 docs/reference/hip_runtime_api/modules_list.rst diff --git a/docs/reference/hip_runtime_api/data_structures.rst b/docs/reference/hip_runtime_api/data_structures.rst new file mode 100644 index 0000000000..55dc15eaea --- /dev/null +++ b/docs/reference/hip_runtime_api/data_structures.rst @@ -0,0 +1,13 @@ +.. meta:: + :description: HIP runtime data structures reference page. + :keywords: AMD, ROCm, HIP, CUDA, HIP runtime data structures + +.. _data_structures_reference: + +******************************************************************************* +Data structures +******************************************************************************* + +The API is organized into modules based on functionality: + +.. include:: data_structures_list.rst diff --git a/docs/reference/hip_runtime_api/data_structures_list.rst b/docs/reference/hip_runtime_api/data_structures_list.rst new file mode 100644 index 0000000000..47110eab2d --- /dev/null +++ b/docs/reference/hip_runtime_api/data_structures_list.rst @@ -0,0 +1,4 @@ +* :doc:`hip:doxygen/html/annotated` +* :doc:`hip:doxygen/html/classes` +* :doc:`hip:doxygen/html/inherits` +* :doc:`hip:doxygen/html/functions_data_fields` \ No newline at end of file diff --git a/docs/reference/hip_runtime_api/files.rst b/docs/reference/hip_runtime_api/files.rst new file mode 100644 index 0000000000..bbef9330c6 --- /dev/null +++ b/docs/reference/hip_runtime_api/files.rst @@ -0,0 +1,14 @@ +.. meta:: + :description: HIP runtime files reference page. + :keywords: AMD, ROCm, HIP, CUDA, HIP runtime files + +.. _files_reference: + +******************************************************************************* +Files +******************************************************************************* + +The list of all files with brief descriptions and a list of all functions, +variables, defines, enums, and typedefs with links to the files they belong to. + +.. include:: files_list.rst diff --git a/docs/reference/hip_runtime_api/files_list.rst b/docs/reference/hip_runtime_api/files_list.rst new file mode 100644 index 0000000000..a4fe1274b6 --- /dev/null +++ b/docs/reference/hip_runtime_api/files_list.rst @@ -0,0 +1,2 @@ +* :doc:`hip:doxygen/html/files` +* :doc:`hip:doxygen/html/globals_globals` \ No newline at end of file diff --git a/docs/reference/hip_runtime_api/modules.rst b/docs/reference/hip_runtime_api/modules.rst index 501a169a85..a9d9a8f44b 100644 --- a/docs/reference/hip_runtime_api/modules.rst +++ b/docs/reference/hip_runtime_api/modules.rst @@ -10,32 +10,4 @@ Modules The API is organized into modules based on functionality: -* :ref:`global_enum_defines_reference` -* :ref:`driver_reference` -* :ref:`device_management_reference` -* :ref:`execution_control_reference` -* :ref:`error_handling_reference` -* :ref:`stream_management_reference` -* :ref:`stream_memory_operations_reference` -* :ref:`event_management_reference` -* :ref:`memory_management_reference` - - * :ref:`external_resource_interoperability_reference` - * :ref:`stream_ordered_memory_allocator_reference` - * :ref:`unified_memory_reference` - * :ref:`virtual_memory_reference` - * :ref:`texture_management_reference` - * :ref:`texture_management_deprecated_reference` - -* :ref:`peer_to_peer_device_memory_access_reference` -* :ref:`context_management_reference` -* :ref:`module_management_reference` -* :ref:`occupancy_reference` -* :ref:`profiler_control_reference` -* :ref:`launch_api_reference` -* :ref:`texture_management_reference` -* :ref:`runtime_compilation_reference` -* :ref:`callback_activity_apis_reference` -* :ref:`graph_management_reference` -* :ref:`opengl_interoperability_reference` -* :ref:`surface_object_reference` +.. include:: modules_list.rst diff --git a/docs/reference/hip_runtime_api/modules/memory_management/virtual_memory_reference.rst b/docs/reference/hip_runtime_api/modules/memory_management/virtual_memory_reference.rst index fbd97aa677..e46b6d91e4 100644 --- a/docs/reference/hip_runtime_api/modules/memory_management/virtual_memory_reference.rst +++ b/docs/reference/hip_runtime_api/modules/memory_management/virtual_memory_reference.rst @@ -1,6 +1,5 @@ .. meta:: - :description: This topic describes introduces Virtual Memory (VM) and shows - how to use it in AMD HIP. + :description: The virtual memory (VM) management reference page. :keywords: AMD, ROCm, HIP, CUDA, virtual memory, virtual, memory, VM .. _virtual_memory_reference: diff --git a/docs/reference/hip_runtime_api/modules_list.rst b/docs/reference/hip_runtime_api/modules_list.rst new file mode 100644 index 0000000000..ad347b894c --- /dev/null +++ b/docs/reference/hip_runtime_api/modules_list.rst @@ -0,0 +1,29 @@ +* :ref:`driver_reference` +* :ref:`device_management_reference` +* :ref:`execution_control_reference` +* :ref:`error_handling_reference` +* :ref:`stream_management_reference` +* :ref:`stream_memory_operations_reference` +* :ref:`event_management_reference` +* :ref:`memory_management_reference` + + * :ref:`external_resource_interoperability_reference` + * :ref:`stream_ordered_memory_allocator_reference` + * :ref:`unified_memory_reference` + * :ref:`virtual_memory_reference` + * :ref:`texture_management_reference` + * :ref:`texture_management_deprecated_reference` + * :ref:`surface_object_reference` + +* :ref:`peer_to_peer_device_memory_access_reference` +* :ref:`context_management_reference` +* :ref:`module_management_reference` +* :ref:`occupancy_reference` +* :ref:`profiler_control_reference` +* :ref:`launch_api_reference` +* :ref:`texture_management_reference` +* :ref:`runtime_compilation_reference` +* :ref:`callback_activity_apis_reference` +* :ref:`graph_management_reference` +* :ref:`opengl_interoperability_reference` +* :ref:`cooperative_groups_reference` \ No newline at end of file diff --git a/docs/reference/hip_runtime_api_reference.rst b/docs/reference/hip_runtime_api_reference.rst index a79da3dbec..d554ba2bc5 100644 --- a/docs/reference/hip_runtime_api_reference.rst +++ b/docs/reference/hip_runtime_api_reference.rst @@ -10,49 +10,22 @@ HIP runtime API This is the full HIP Runtime API reference. -Modules +:doc:`Modules ` ============================================================ The API is organized into modules based on functionality. -* :ref:`global_enum_defines_reference` -* :ref:`driver_reference` -* :ref:`device_management_reference` -* :ref:`execution_control_reference` -* :ref:`error_handling_reference` -* :ref:`stream_management_reference` -* :ref:`stream_memory_operations_reference` -* :ref:`event_management_reference` -* :ref:`memory_management_reference` - - * :ref:`external_resource_interoperability_reference` - * :ref:`stream_memory_operations_reference` - * :ref:`unified_memory_reference` - * :ref:`virtual_memory_reference` - -* :ref:`peer_to_peer_device_memory_access_reference` -* :ref:`context_management_reference` -* :ref:`module_management_reference` -* :ref:`occupancy_reference` -* :ref:`profiler_control_reference` -* :ref:`launch_api_reference` -* :ref:`texture_management_reference` -* :ref:`runtime_compilation_reference` -* :ref:`callback_activity_apis_reference` -* :ref:`graph_management_reference` -* :ref:`opengl_interoperability_reference` -* :ref:`surface_object_reference` - -Data structures +.. include:: hip_runtime_api/modules_list.rst + +:doc:`Global defines and enums ` +========================================================================= + +:doc:`Data structures ` ============================================================ -* :doc:`/doxygen/html/annotated` -* :doc:`/doxygen/html/classes` -* :doc:`/doxygen/html/inherits` -* :doc:`/doxygen/html/functions_data_fields` +.. include:: hip_runtime_api/data_structures_list.rst -Files +:doc:`Files ` ============================================================ -* :doc:`/doxygen/html/files` -* :doc:`/doxygen/html/globals_globals` +.. include:: hip_runtime_api/files_list.rst \ No newline at end of file diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 53e7cc67d1..f1ffcf33dc 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -48,6 +48,7 @@ subtrees: - file: reference/hip_runtime_api/modules/execution_control - file: reference/hip_runtime_api/modules/error_handling - file: reference/hip_runtime_api/modules/stream_management + - file: reference/hip_runtime_api/modules/stream_memory_operations - file: reference/hip_runtime_api/modules/event_management - file: reference/hip_runtime_api/modules/memory_management subtrees: @@ -70,9 +71,19 @@ subtrees: - file: reference/hip_runtime_api/modules/graph_management - file: reference/hip_runtime_api/modules/opengl_interoperability - file: reference/hip_runtime_api/modules/cooperative_groups_reference - - file: reference/hip_runtime_api/global_enum_and_defines - - file: doxygen/html/annotated_data_structures - - file: doxygen/html/files_files + - file: doxygen/html/group___global_defs + - file: reference/hip_runtime_api/data_structures + subtrees: + - entries: + - file: doxygen/html/annotated + - file: doxygen/html/classes + - file: doxygen/html/inherits + - file: doxygen/html/functions_data_fields + - file: reference/hip_runtime_api/files + subtrees: + - entries: + - file: doxygen/html/files + - file: doxygen/html/globals_globals - file: reference/virtual_rocr - file: reference/cpp_language_extensions title: C++ language extensions