add sphinx configurations

Change-Id: I1a66a02b18fb699415a87a6473eb72c097a13b5f


[ROCm/ROCR-Runtime commit: 57b3fcde51]

projects/rocr-runtime/runtime/hsa-runtime/README.md

@@ -1,122 +1,134 @@
-### Package Contents
+# Package Contents
 
 This directory contains the ROC Runtime source code based on the HSA Runtime
 but modified to support AMD/ATI discrete GPUs.
 
-#### Source & Include Directories
+## Source & Include Directories
 
-core - Contains the source code for AMD's implementation of the core HSA Runtime API's.
+`core` - Contains the source code for AMD's implementation of the core HSA
+         Runtime API's.
 
-cmake_modules - CMake support modules and files.
+`cmake_modules` - CMake support modules and files.
 
-inc - Contains the public and AMD specific header files exposing the HSA Runtimes interfaces.
+`inc` - Contains the public and AMD specific header files exposing the HSA
+        Runtime`s interfaces.
 
-libamdhsacode - Code object definitions and interface.
+`libamdhsacode` - Code object definitions and interface.
 
-loader - Used to load code objects.
+`loader` - Used to load code objects.
 
-utils - Utilities required to build the core runtime.
+`utils` - Utilities required to build the core runtime.
 
-#### Build Environment
+## Build Environment
 
 CMake build framework is used to build the ROC runtime. The minimum version is
 3.7.
 
-Obtain cmake infrastructure: http://www.cmake.org/download/
+Obtain cmake infrastructure: <http://www.cmake.org/download/>
 
 Export cmake bin into your PATH
 
-#### Package Dependencies
+## Package Dependencies
 
 The following support packages are required to successfully build the runtime:
 
-* libelf-dev
-* g++
+* `libelf-dev`
+* `g++`
 
-#### Building the Runtime
+## Building the Runtime
 
-To build the runtime a compatible version of the libhsakmt library and the
-hsakmt.h header file must be available. The latest version of these files
+To build the runtime a compatible version of the `libhsakmt` library and the
+`hsakmt.h` header file must be available. The latest version of these files
 can be obtained from the ROCT-Thunk-Interface repository, available here:
 
-https://github.com/RadeonOpenCompute/ROCT-Thunk-Interface
+<https://github.com/RadeonOpenCompute/ROCT-Thunk-Interface>
 
-As of ROCm release 3.7 libhsakmt development packages now include a cmake
-package config file. The runtime will now locate libhsakmt via find_package if
-libhsakmt is installed to a standard location. For installations that do not
-use ROCm standard paths set cmake variables CMAKE_PREFIX_PATH or hsakmt_DIR to
-override find_package search paths.
+As of ROCm release 3.7 `libhsakmt` development packages now include a CMake
+package config file. The runtime will now locate `libhsakmt` via `find_package`
+if `libhsakmt` is installed to a standard location. For installations that do
+not use ROCm standard paths set CMake variables `CMAKE_PREFIX_PATH` or
+`hsakmt_DIR` to override `find_package` search paths.
 
 As of ROCm release 3.7 the runtime includes an optional image support module
-(previously hsa-ext-rocr-dev). By default this module is included in builds of
+(previously `hsa-ext-rocr-dev`). By default this module is included in builds of
 the runtime. The image module may be excluded the runtime by setting
-cmake variable IMAGE_SUPPORT to OFF.
+CMake variable `IMAGE_SUPPORT` to `OFF`.
 
 When building the optional image module additional build dependencies are
-required. An amdgcn compatible clang and device library must be installed
+required. An AMDGCN compatible clang and device library must be installed
 to build the image module. The latest version of these requirements can be
 obtained from the ROCm package repository
-(see: https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html)
+(see:
+<https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html>)
 The latest source for these projects may be found here:
 
-https://github.com/RadeonOpenCompute/llvm-project
+<https://github.com/RadeonOpenCompute/llvm-project>
 
-https://github.com/RadeonOpenCompute/ROCm-Device-Libs
+<https://github.com/RadeonOpenCompute/ROCm-Device-Libs>
 
-Additionally xxd must be installed.
+Additionally `xxd` must be installed.
 
 The runtime optionally supports use of the cmake user package registry. By
-default the registry is not modified. Set cmake variable
-EXPORT_TO_USER_PACKAGE_REGISTRY to ON to enable updating the package registry.
+default the registry is not modified. Set CMake variable
+`EXPORT_TO_USER_PACKAGE_REGISTRY` to `ON` to enable updating the package
+registry.
 
 For example, to build, install, and produce packages on a system with standard
-ROCm packages installed, execute the following from src/:
+ROCm packages installed, execute the following from `src/`:
 
-    mkdir build
-    cd build
-    cmake -DCMAKE_INSTALL_PATH=/opt/rocm ..
-    make
-    make install
-    make package
+```bash
+mkdir build
+cd build
+cmake -DCMAKE_INSTALL_PATH=/opt/rocm ..
+make
+make install
+make package
+```
 
 Example with a custom installation path, build dependency path, and options:
 
-    cmake -DIMAGE_SUPPORT=OFF \
-          -DEXPORT_TO_USER_PACKAGE_REGISTRY=ON \
-          -DCMAKE_VERBOSE_MAKEFILE=1 \
-          -DCMAKE_PREFIX_PATH=<alternate path(s) to build dependencies> \
-          -DCMAKE_INSTALL_PATH=<custom install path for this build> \
-          ..
+```bash
+cmake -DIMAGE_SUPPORT=OFF \
+      -DEXPORT_TO_USER_PACKAGE_REGISTRY=ON \
+      -DCMAKE_VERBOSE_MAKEFILE=1 \
+      -DCMAKE_PREFIX_PATH=<alternate path(s) to build dependencies> \
+      -DCMAKE_INSTALL_PATH=<custom install path for this build> \
+      ..
+```
 
-Alternately ccmake and cmake-gui are supported:
+Alternately `ccmake` and `cmake-gui` are supported:
 
-    mkdir build
-    cd build
-    ccmake ..
-    press c to configure
-    populate variables as desired
-    press c again
-    press g to generate and exit
-    make
+```bash
+mkdir build
+cd build
+ccmake ..
+press c to configure
+populate variables as desired
+press c again
+press g to generate and exit
+make
+```
 
-#### Building Against the Runtime
+## Building Against the Runtime
 
-The runtime provides a cmake package config file, installed by default to
-/opt/rocm/lib/cmake/hsa-runtime64. The runtime exports cmake target
-hsa-runtime64 in namespace hsa-runtime64. A cmake project (Foo) using the
+The runtime provides a CMake package config file, installed by default to
+`/opt/rocm/lib/cmake/hsa-runtime64`. The runtime exports CMake target
+`hsa-runtime64` in namespace `hsa-runtime64`. A CMake project (`Foo`) using the
 runtime may locate, include, and link the runtime with the following template:
 
-    Add /opt/rocm to CMAKE_PREFIX_PATH.
+```cmake
+# Add /opt/rocm to CMAKE_PREFIX_PATH.
 
-    find_package(hsa-runtime64 1.0 REQUIRED)
-    ...
-    add_library(Foo ...)
-    ...
-    target_link_library(Foo PRIVATE hsa-runtime64::hsa-runtime64)
+find_package(hsa-runtime64 1.0 REQUIRED)
+...
+add_library(Foo ...)
+...
+target_link_libraries(Foo PRIVATE hsa-runtime64::hsa-runtime64)
+```
 
-#### Specs
+## Specs
 
-http://www.hsafoundation.com/standards/
+<http://www.hsafoundation.com/standards/>
 
 HSA Runtime Specification 1.1
 
@@ -124,7 +136,7 @@ HSA Programmer Reference Manual Specification 1.1
 
 HSA Platform System Architecture Specification 1.1
 
-#### Runtime Design Overview
+## Runtime Design Overview
 
 The AMD ROC runtime consists of three primary layers:
 
@@ -136,12 +148,12 @@ Additionally the runtime is dependent on a small utility library which provides
 simple common functions, limited operating system and compiler abstraction, as
 well as atomic operation interfaces.
 
-#### C Interface Adaptors
+## C Interface Adaptors
 
 Files:
 
-* hsa.h(cpp)
-* hsa_ext_interface.h(cpp)
+* `hsa.h`(cpp)
+* `hsa_ext_interface.h`(cpp)
 
 The C interface layer provides C99 APIs as defined in the HSA Runtime
 Specification 1.1. The interfaces and default definitions for the standard
@@ -151,58 +163,58 @@ default definitions, which simply return an appropriate error code. If
 available the extension library is loaded as part of runtime initialization and
 the table is updated to point into the extension library.
 
-#### C++ Interfaces Classes & Common Functions
+## C++ Interfaces Classes & Common Functions
 
 Files:
 
-* runtime.h(cpp)
-* agent.h
-* queue.h
-* signal.h
-* memory_region.h(cpp)
-* checked.h
-* memory_database.h(cpp)
-* default_signal.h(cpp)
+* `runtime.h`(cpp)
+* `agent.h`
+* `queue.h`
+* `signal.h`
+* `memory_region.h`(cpp)
+* `checked.h`
+* `memory_database.h`(cpp)
+* `default_signal.h`(cpp)
 
 The C++ interface layer provides abstract interface classes encapsulating
 commands to HSA Signals, Agents, and Queues. This layer also contains the
-implementation of device independent commands, such as hsa_init and
-hsa_system_get_info, and a default signal and queue implementation.
+implementation of device independent commands, such as `hsa_init` and
+`hsa_system_get_info`, and a default signal and queue implementation.
 
-#### Device Specific Implementations
+## Device Specific Implementations
 
 Files:
 
-* amd_cpu_agent.h(cpp)
-* amd_gpu_agent.h(cpp)
-* amd_hw_aql_command_processor.h(cpp)
-* amd_memory_region.h(cpp)
-* amd_memory_registration.h(cpp)
-* amd_topology.h(cpp)
-* host_queue.h(cpp)
-* interrupt_signal.h(cpp)
-* hsa_ext_private_amd.h(cpp)
+* `amd_cpu_agent.h`(cpp)
+* `amd_gpu_agent.h`(cpp)
+* `amd_hw_aql_command_processor.h`(cpp)
+* `amd_memory_region.h`(cpp)
+* `amd_memory_registration.h`(cpp)
+* `amd_topology.h`(cpp)
+* `host_queue.h`(cpp)
+* `interrupt_signal.h`(cpp)
+* `hsa_ext_private_amd.h`(cpp)
 
 The device specific layer contains implementations of the C++ interface classes
 which implement HSA functionality for ROCm supported devices.
 
-#### Implemented Functionality
+## Implemented Functionality
 
 * The following queries are not implemented:
 
-  * hsa_code_symbol_get_info: 
-    * HSA_CODE_SYMBOL_INFO_INDIRECT_FUNCTION_CALL_CONVENTION
-  * hsa_executable_symbol_get_info:
-    * HSA_EXECUTABLE_SYMBOL_INFO_INDIRECT_FUNCTION_OBJECT
-    * HSA_EXECUTABLE_SYMBOL_INFO_INDIRECT_FUNCTION_CALL_CONVENTION
+  * `hsa_code_symbol_get_info`:
+    * `HSA_CODE_SYMBOL_INFO_INDIRECT_FUNCTION_CALL_CONVENTION`
+  * `hsa_executable_symbol_get_info`:
+    * `HSA_EXECUTABLE_SYMBOL_INFO_INDIRECT_FUNCTION_OBJECT`
+    * `HSA_EXECUTABLE_SYMBOL_INFO_INDIRECT_FUNCTION_CALL_CONVENTION`
 
-#### Known Issues
+## Known Issues
 
-* hsa_agent_get_exception_policies is not implemented.
-* hsa_system_get_extension_table is not implemented for
-  HSA_EXTENSION_AMD_PROFILER.
+* `hsa_agent_get_exception_policies` is not implemented.
+* `hsa_system_get_extension_table` is not implemented for
+  `HSA_EXTENSION_AMD_PROFILER`.
 
-#### Disclaimer
+## Disclaimer
 
 The information contained herein is for informational purposes only, and is
 subject to change without notice. While every precaution has been taken in the
@@ -224,4 +236,4 @@ Micro Devices, Inc. Other product names used in this publication are for
 identification purposes only and may be trademarks of their respective
 companies.
 
-Copyright (c) 2014-2021 Advanced Micro Devices, Inc. All rights reserved.
+Copyright © 2014-2021 Advanced Micro Devices, Inc. All rights reserved.