[ROCmInfo] docs: mono-repo changes and style edits (#2584)

* initial edits * mono repo related updates * standardize component name * style edits * more edits
2026-01-20 18:06:54 -05:00
commit 05a6d017c6
@@ -1,15 +1,13 @@
 The University of Illinois/NCSA
 Open Source License (NCSA)

-Copyright (c) 2014-2017, Advanced Micro Devices, Inc. All rights reserved.
+Copyright (c) 2014-2026, Advanced Micro Devices, Inc. All rights reserved.

 Developed by:

-                AMD Research and AMD HSA Software Development
-
-                Advanced Micro Devices, Inc.
-
-                www.amd.com
+* AMD Research and AMD HSA Software Development
+* Advanced Micro Devices, Inc.
+* www.amd.com

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to
@@ -18,15 +16,15 @@ the rights to use, copy, modify, merge, publish, distribute, sublicense,
 and/or sell copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following conditions:

- - Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimers.
- - Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimers in
-   the documentation and/or other materials provided with the distribution.
- - Neither the names of Advanced Micro Devices, Inc,
-   nor the names of its contributors may be used to endorse or promote
-   products derived from this Software without specific prior written
-   permission.
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimers.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimers in
+  the documentation and/or other materials provided with the distribution.
+* Neither the names of Advanced Micro Devices, Inc,
+  nor the names of its contributors may be used to endorse or promote
+  products derived from this Software without specific prior written
+  permission.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -25,5 +25,5 @@ html_title = f"rocminfo {version} Documentation"
 project = "rocminfo"
 author = "Advanced Micro Devices, Inc."
 copyright = (
-    "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved."
+    "Copyright (c) 2026 Advanced Micro Devices, Inc. All rights reserved."
 )
@@ -1,14 +1,14 @@
 .. meta::
-  :description: agent, enumerator ROCmInfo
-  :keywords: install, rocminfo, AMD, ROCm, ROCmInfo
+  :description: agent, enumerator rocminfo
+  :keywords: install, rocminfo, AMD, ROCm


 Using ROCm agent enumerator
 -----------------------------

-The rocm_agent_enumerator tool prints the list of available AMD GCN ISA or acthitecture names. With the option ‘-name’, it prints out available architecture names that can be used by third-party scripts to determine which ISAs are needed to execute code on all GPUs in the system.
+The ``rocm_agent_enumerator`` tool prints a list of available AMD GCN ISA or acthitecture names. With the option ``-name``, it prints out architecture names that can be used by third-party scripts to determine which ISAs are required to execute code across all GPUs in the system.

-See the following example output of the rocm_agent_enumerator command on a system with an MI-300X installation,
+See the following example output of the ``rocm_agent_enumerator`` command on a system with an MI300X installation:

 .. code-block::

@@ -18,5 +18,5 @@ See the following example output of the rocm_agent_enumerator command on a syste

 .. Note::

-The gfx000 represents the CPU agent.
+    ``gfx000`` represents the CPU agent.

@@ -1,21 +1,21 @@
 .. meta::
-  :description: Using ROCmInfo
+  :description: Using rocminfo
  :keywords: rocminfo, enumerator, info, AMD, ROCm, HSA, hsa


 ================
-Using ROCmInfo
+Using rocminfo
 ================

-The ROCmInfo command provides information about the Heterogenous System Architecture (HSA) system attributes and agents. Each agent represents a device and a device can be a CPU or a GPU.
+The rocminfo command provides information about Heterogenous System Architecture (HSA) system attributes and agents. Each agent represents a device, which can be either a CPU or a GPU.

 The output has the following two sections:

-* HSA System Attributes - List of general information of the system.
+* HSA System Attributes: A list of system-level information.

-* HSA agents - List of devices in the system.
+* HSA agents: A list of devices in the system.

-See the following example output of the ROCmInfo command on a system with MI300X:
+See the following example output of the rocminfo command on a system with MI300X:

 .. code-block::

@@ -1,14 +1,14 @@
 .. meta::
-  :description: Install ROCmInfo
+  :description: Install rocminfo
  :keywords: install, rocminfo, AMD, ROCm

-ROCmInfo documentation
+rocminfo documentation
 *************************

-ROCmInfo is a ROCm application for reporting system information. It is a tool shipped to enumerate GPU agents available on a working ROCm stack.
+rocminfo is a ROCm application that reports system information and enumerates GPU agents available on a working ROCm stack.


-You can access ROCmInfo code at `GitHub. <https://github.com/ROCm/rocminfo>`_
+You can access the rocminfo source code on `GitHub. <https://github.com/ROCm/rocm-systems/tree/develop/projects/rocminfo>`_

 .. grid:: 2
  :gutter: 3
@@ -1,17 +1,16 @@
 .. meta::
-  :description: Install ROCmInfo
+  :description: Install rocminfo
  :keywords: install, rocminfo, AMD, ROCm


-Building ROCmInfo
+Building rocminfo
 *****************

-Use the standard cmake build procedure to build ROCmInfo. The location of ROCm root (parent directory containing ROCM headers and libraries) must be provided
-as a CMake argument using the standard CMAKE_PREFIX_PATH CMake variable.
+Use the standard CMake build procedure to build rocminfo. The ROCm root directory (the parent directory containing ROCM headers and libraries) must be provided as a CMake argument using the standard ``CMAKE_PREFIX_PATH`` variable.

-After cloning the ROCmInfo git repo, you must perform a `git-fetch --tags` to get the tags residing on the repo. These tags are used for versioning.
+After cloning the `rocminfo Git repository <https://github.com/ROCm/rocm-systems/tree/develop/projects/rocminfo>`_, run ``git-fetch --tags`` to retrieve the repository tags, which are used for versioning.

-For example,
+For example:

 .. code-block::

@@ -29,21 +28,21 @@ For example,

    cd ..

-Upon a successful build, the binary, ROCmInfo, and the Python script, rocm_agent_enumerator, will be in the `build` folder.
+Upon a successful build, the rocminfo binary and the Python script ``rocm_agent_enumerator`` will present in the ``build`` directory.

-ROCmInfo execution
+rocminfo execution
 -------------------

-"rocminfo" gives information about the HSA system attributes and agents.
+rocminfo reports information about HSA system attributes and agents.

-"rocm_agent_enumerator" prints the list of available AMD GCN ISA or architecture names. With the option '-name', it prints out available architectures names obtained from ROCmInfo. Otherwise, it generates ISA in one of five different ways:
+``rocm_agent_enumerator`` prints a list of AMD GCN ISA or architecture names. With the option ``-name``, it prints out the available architecture names obtained from rocminfo. Otherwise, it generates the ISA in one of the following ways:

-1. ROCM_TARGET_LST : a user defined environment variable, set to the path and filename where to find the "target.lst" file. This can be used in an install environment with sandbox, where execution of "rocminfo" is not possible.
+* ``ROCM_TARGET_LST``: A user-defined environment variable that specifies the path to the ``target.lst`` file. This can be used in a sandboxed install environment where executing rocminfo is not possible.

-2. target.lst : user-supplied text file, in the same folder as "rocm_agent_enumerator". This is used in a container setting where ROCm stack may usually not available.
+* ``target.lst``: A user-supplied text file in the same folder as ``rocm_agent_enumerator``. This can be used in a container environment where the ROCm stack is not available.

-3. HSA topology : gathers the information from the HSA node topology in /sys/class/kfd/kfd/topology/nodes/
+* HSA topology: Gathers information from the HSA node topology under ``/sys/class/kfd/kfd/topology/nodes/``.

-4. lspci : enumerate PCI bus and locate supported devices from a hard-coded lookup table.
+* ``lspci``: Enumerates the PCI bus and locates supported devices from a hard-coded lookup table.

-5. ROCmInfo : a tool shipped with this script to enumerate GPU agents available on a working ROCm stack.
+* rocminfo: A tool shipped with this script to enumerate GPU agents available on a working ROCm stack.
@@ -5,12 +5,12 @@ subtrees:
 - caption: Install
  entries:
  - file: install/build.rst
-    title: ROCmInfo installation
+    title: Build rocminfo

 - caption: How to
  entries:
  - file: how-to/use-rocminfo.rst
-    title: Use ROCmInfo
+    title: Use rocminfo
  - file: how-to/use-rocm-agent-enumerator.rst
    title: Use ROCm agent enumerator