diff --git a/docs/faq.rst b/docs/faq.rst index 31cc134044..0bfc4b5163 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -23,13 +23,13 @@ What operating systems does HIP support? ---------------------------------------- Linux as well as Windows are supported by ROCm. The exact versions are listed in -the system requirements for :ref:`rocm-install-on-linux:supported_distributions -` and :ref:`rocm-install-on-windows:supported-skus-win`. +the system requirements for :ref:`rocm-install-on-linux:supported_distributions` +and :ref:`rocm-install-on-windows:supported-skus-win`. .. note:: Not all HIP runtime API functions are yet supported on Windows. A note is added to those functions' documentation in the - :ref:`runtime_api_reference`. + :ref:`HIP runtime API reference`. What libraries does HIP provide? -------------------------------- @@ -43,7 +43,7 @@ What NVIDIA CUDA features does HIP support? The :doc:`NVIDIA CUDA runtime API supported by HIP` and :doc:`NVIDIA CUDA driver API suupported by HIP` pages describe which NVIDIA CUDA APIs are supported and what the equivalents are. -The :doc:`HIP API documentation ` describes each API and +The :doc:`HIP API documentation ` describes each API and its limitations, if any, compared with the equivalent CUDA API. The kernel language features are documented in the @@ -75,10 +75,10 @@ HIP offers several benefits over OpenCL: * Host and device code can be mixed in the source files. * The HIP API is less verbose than OpenCL and is familiar to CUDA developers. * Porting from CUDA to HIP is significantly easier than from CUDA to OpenCL. -* HIP uses development tools specialized for each platform: :ref:`amdclang++ ` - for AMD GPUs or :xref:`nvcc ` - for NVIDIA GPUs, and profilers like :ref:`omniperf ` or - :xref:`Nsight Systems `. +* HIP uses development tools specialized for each platform: :doc:`amdclang++ ` + for AMD GPUs or `nvcc `_ + for NVIDIA GPUs, and profilers like :doc:`omniperf ` or + `Nsight Systems `_. * HIP provides * pointers and host-side pointer arithmetic. * device-level control over memory allocation and placement. @@ -107,7 +107,7 @@ Yes, but you require a compatible GPU to run the compiled code. On NVIDIA platforms, can I mix HIP code with CUDA code? ------------------------------------------------------- -Yes. Most HIP types and data structures are `typedef`s to CUDA equivalents and +Yes. Most HIP types and data structures are ``typedef`` s to CUDA equivalents and can be used interchangeably. This can be useful for iteratively porting CUDA code. See :doc:`how-to/hip_porting_guide` for more details. @@ -127,23 +127,23 @@ hipcc detected my platform incorrectly. What should I do? The environment variable `HIP_PLATFORM` can be used to specify the platform for which the code is going to be compiled with ``hipcc``. See the -:doc:`hipcc environment variables` for more information. +:doc:`hipcc environment variables` for more information. How to use HIP-Clang to build HIP programs? ------------------------------------------------------ -:ref:`hipcc ` is a compiler driver. This means it is not a compiler +:doc:`hipcc ` is a compiler driver. This means it is not a compiler but calls the appropriate compilers and sets some options. -The underlying compilers are :ref:`amdclang++ ` or -:xref:`nvcc `, +The underlying compilers are :doc:`amdclang++ ` or +`nvcc `_, depending on the platform, and can be called directly. What is HIP-Clang? ------------------ HIP-Clang is a Clang/LLVM-based compiler used to compile HIP programs for AMD -platforms. The executable is named :ref:`amdclang++ ` on +platforms. The executable is named :doc:`amdclang++ ` on Linux and ``clang++`` on Windows. Can I link HIP device code with host code compiled with another compiler such as gcc, icc, or clang? @@ -158,7 +158,7 @@ Can HIP applications be compiled with a C compiler? HIP is a C/C++ API that can be used with C compilers. However, this applies only to the API itself. Device code and the syntax for calling kernels must be -compiled with a supported compiler like :ref:`hipcc `. The code +compiled with a supported compiler like :doc:`hipcc `. The code objects that are generated with ``hipcc`` can, however, be used with a C compiler, as shown in the code examples below. diff --git a/docs/index.md b/docs/index.md index 28d7d4f287..f93a04008c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -41,7 +41,6 @@ The HIP documentation is organized into the following categories: * {doc}`./how-to/stream_ordered_allocator` * [Cooperative groups](./how-to/cooperative_groups) * [HIP graphs](./how-to/hipgraph) -* {doc}`./how-to/faq` :::