formatting cleanup

ROCm · Nov 22, 2023 · 654a5c8 · 654a5c8
1 parent dfc63c7
commit 654a5c8
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 113 deletions.
diff --git a/docs/how-to/prerequisites.rst b/docs/how-to/prerequisites.rst
@@ -2,8 +2,7 @@
 Installation prerequisites
 *********************************************************************
 
-You must perform the following steps before installing ROCm and check if the
-system meets all the requirements to proceed with the installation.
+Before installing ROCm, complete the following prerequisites.
 
 1. Confirm the system has a supported Linux version.
 
@@ -14,11 +13,10 @@ system meets all the requirements to proceed with the installation.
 
             uname -m && cat /etc/*release
 
-    b. Confirm that the obtained Linux distribution information matches with those listed in
-    :ref:`supported_distributions`.
+    b. Confirm that your Linux distribution matches a
+    :ref:`supported distribution<supported_distributions>`.
 
-        **Example:** Running the command above on an Ubuntu system results in the
-        following output:
+        **Example:** Running the preceding command on an Ubuntu system produces the following output:
 
         .. code-block:: shell
 
@@ -28,22 +26,22 @@ system meets all the requirements to proceed with the installation.
                 DISTRIB_CODENAME=focal
                 DISTRIB_DESCRIPTION="Ubuntu 20.04.5 LTS"
 
-2. Verify the kernel version using the following steps:
+2. Verify the kernel version.
 
     a. To check the kernel version of your Linux system, type the following command:
 
         .. code-block:: shell
 
             uname -srmv
 
-        **Example:** The output of the command above lists the kernel version in the following format:
+        **Example:** The preceding command lists the kernel version in the following format:
 
         .. code-block:: shell
 
             Linux 5.15.0-46-generic #44~20.04.5-Ubuntu SMP Fri Jun 24 13:27:29 UTC 2022 x86_64
 
-    b. Confirm that the obtained kernel version information matches with system requirements as listed
-    in :ref:`supported_distributions`.
+    b. Confirm that your kernel version matches the system requirements, as listed in
+    :ref:`supported_distributions`.
 
 Additional package repositories
 ==========================================================
@@ -60,7 +58,7 @@ installation. Follow the instructions below based on your distributions.
 
     .. tab-item:: Red Hat Enterprise Linux
 
-        1. Add the EPEL repository:
+        1. Add the EPEL repository.
 
            .. tab-set::
 
@@ -79,7 +77,7 @@ installation. Follow the instructions below based on your distributions.
                        wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
                        sudo rpm -ivh epel-release-latest-8.noarch.rpm
 
-        2. Enable the CodeReady Linux Builder repository:
+        2. Enable the CodeReady Linux Builder repository.
 
            .. code-block:: shell
 

diff --git a/docs/how-to/spack.rst b/docs/how-to/spack.rst
@@ -13,108 +13,61 @@ Most importantly, Spack is *simple*. It offers a simple *spec* syntax, so users
 versions and configuration options. Spack is also simple for package authors: package files are written
 in pure Python, and specs allow package authors to maintain a single file for many different builds of
 the same package. For more information on Spack, see the
-`Spack Tutorial <https://spack-tutorial.readthedocs.io/en/latest/>`_.
+`Spack tutorial <https://spack-tutorial.readthedocs.io/en/latest/>`_.
 
 ROCM packages in Spack
 ===================================================
 
-.. list-table::
-    :header-rows: 1
-
-    * - Component
-      - ``Spack Package Name``
-    * - ``rocm-cmake``
-      - ``rocm-cmake``
-    * - ``thunk``
-      - ``hsakmt-roct``
-    * - ``rocm-smi-lib``
-      - ``rocm-smi-lib``
-    * - ``hsa``
-      - ``hsa-rocr-dev``
-    * - ``lightning``
-      - ``llvm-amdgpu``
-    * - ``devicelibs``
-      - ``rocm-device-libs``
-    * - ``comgr``
-      - ``comgr``
-    * - ``rocclr (vdi)``
-      - ``hip-rocclr``
-    * - ``hipify_clang``
-      - ``hipify-clang``
-    * - ``hip (hip_in_vdi)``
-      - ``hip``
-    * - ``ocl (opencl_on_vdi )``
-      - ``rocm-opencl``
-    * - ``rocminfo``
-      - ``rocminfo``
-    * - ``clang-ocl``
-      - ``rocm-clang-ocl``
-    * - ``rccl``
-      - ``rccl``
-    * - ``atmi``
-      - ``atmi``
-    * - ``rocm_debug_agent``
-      - ``rocm-debug-agent``
-    * - ``rocm_bandwidth_test``
-      - ``rocm-bandwidth-test``
-    * - ``rocprofiler``
-      - ``rocprofiler-dev``
-    * - ``roctracer-dev-api``
-      - ``roctracer-dev-api``
-    * - ``roctracer``
-      - ``roctracer-dev``
-    * - ``dbgapi``
-      - ``rocm-dbgapi``
-    * - ``rocm-gdb``
-      - ``rocm-gdb``
-    * - ``openmp-extras``
-      - ``rocm-openmp-extras``
-    * - ``rocBLAS``
-      - ``rocblas``
-    * - ``hipBLAS``
-      - ``hipblas``
-    * - ``rocFFT``
-      - ``rocfft``
-    * - ``rocRAND``
-      - ``rocrand``
-    * - ``rocSPARSE``
-      - ``rocsparse``
-    * - ``hipSPARSE``
-      - ``hipsparse``
-    * - ``rocALUTION``
-      - ``rocalution``
-    * - ``rocSOLVER``
-      - ``rocsolver``
-    * - ``rocPRIM``
-      - ``rocprim``
-    * - ``rocThrust``
-      - ``rocthrust``
-    * - ``hipCUB``
-      - ``hipcub``
-    * - ``hipfort``
-      - ``hipfort``
-    * - ``ROCmValidationSuite``
-      - ``rocm-validation-suite``
-    * - ``MIOpenGEMM``
-      - ``miopengemm``
-    * - ``MIOpen(Hip variant)``
-      - ``miopen-hip``
-    * - ``MIOpen(opencl)``
-      - ``miopen-opencl``
-    * - ``MIVisionX``
-      - ``mivisionx``
-    * - ``AMDMIGraphX``
-      - ``migraphx``
-    * - ``rocm-tensile``
-      - ``rocm-tensile``
-    * - ``hipfft``
-      - ``hipfft``
-    * - ``RDC``
-      - ``rdc``
-    * - ``hipsolver``
-      - ``hipsolver``
-    * - ``mlirmiopen``
-      - ``mlirmiopen``
+.. csv-table::
+  :widths: 30, 70
+  :header: "Component", "Package name"
+
+    ``rocm-cmake``, ``rocm-cmake``
+    ``thunk``, ``hsakmt-roct``
+    ``rocm-smi-lib``, ``rocm-smi-lib``
+    ``hsa``, ``hsa-rocr-dev``
+    ``lightning``, ``llvm-amdgpu``
+    ``devicelibs``, ``rocm-device-libs``
+    ``comgr``, ``comgr``
+    ``rocclr (vdi)``, ``hip-rocclr``
+    ``hipify_clang``, ``hipify-clang``
+    ``hip (hip_in_vdi)``, ``hip``
+    ``ocl (opencl_on_vdi )``, ``rocm-opencl``
+    ``rocminfo``, ``rocminfo``
+    ``clang-ocl``, ``rocm-clang-ocl``
+    ``rccl``, ``rccl``
+    ``atmi``, ``atmi``
+    ``rocm_debug_agent``, ``rocm-debug-agent``
+    ``rocm_bandwidth_test``, ``rocm-bandwidth-test``
+    ``rocprofiler``, ``rocprofiler-dev``
+    ``roctracer-dev-api``, ``roctracer-dev-api``
+    ``roctracer``, ``roctracer-dev``
+    ``dbgapi``, ``rocm-dbgapi``
+    ``rocm-gdb``, ``rocm-gdb``
+    ``openmp-extras``, ``rocm-openmp-extras``
+    ``rocBLAS``, ``rocblas``
+    ``hipBLAS``, ``hipblas``
+    ``rocFFT``, ``rocfft``
+    ``rocRAND``, ``rocrand``
+    ``rocSPARSE``, ``rocsparse``
+    ``hipSPARSE``, ``hipsparse``
+    ``rocALUTION``, ``rocalution``
+    ``rocSOLVER``, ``rocsolver``
+    ``rocPRIM``, ``rocprim``
+    ``rocThrust``, ``rocthrust``
+    ``hipCUB``, ``hipcub``
+    ``hipfort``, ``hipfort``
+    ``ROCmValidationSuite``, ``rocm-validation-suite``
+    ``MIOpenGEMM``, ``miopengemm``
+    ``MIOpen(Hip variant)``, ``miopen-hip``
+    ``MIOpen(opencl)``, ``miopen-opencl``
+    ``MIVisionX``, ``mivisionx``
+    ``AMDMIGraphX``, ``migraphx``
+    ``rocm-tensile``, ``rocm-tensile``
+    ``hipfft``, ``hipfft``
+    ``RDC``, ``rdc``
+    ``hipsolver``, ``hipsolver``
+    ``mlirmiopen``, ``mlirmiopen``
 
 .. note::
     You must install all prerequisites before installing Spack.
@@ -234,7 +187,6 @@ Installing ROCm components using Spack
 
     For example:
 
-
     .. code-block:: shell
 
         root@[ixt-rack-104:/spack\#](http://ixt-rack-104/spack) spack info mivisionx

diff --git a/docs/reference/system-requirements.rst b/docs/reference/system-requirements.rst
@@ -114,10 +114,10 @@ Support status:
 ⚠️: **Deprecated** - Support will be removed in a future release.
 ❌: **Unsupported** - This configuration is not enabled in our software distributions.
 
-Supported OS
+Supported operating systems
 =============================================
 
-AMD ROCm™ Platform supports the following Linux distributions.
+AMD ROCm™ Software supports the following Linux distributions.
 
 .. list-table::
     :widths: 50 50 25