From 222288a49261db23bd8468d38d62eeb7764e58ca Mon Sep 17 00:00:00 2001 From: Tony Date: Thu, 6 Feb 2020 14:46:19 -0500 Subject: [PATCH] Update documentation - Update README-ROCM.md - Remove unnecessary @indent from gdb.texinfo copyright block - Correct spelling mistake in gdb.texinfo Change-Id: I56dde693570119683bfcc86d85ae8eebe522eff5 --- README-ROCM.md | 49 ++++++++++++++++++++++++++++----------------- gdb/doc/gdb.texinfo | 2 +- 2 files changed, 32 insertions(+), 19 deletions(-) diff --git a/README-ROCM.md b/README-ROCM.md index af6547c37be..848c0c99dde 100644 --- a/README-ROCM.md +++ b/README-ROCM.md @@ -1,27 +1,40 @@ ROCm Debugger (ROCgdb) ====================== -This is ROCgdb, the ROCm source-level debugger for Linux, based on GDB, the GNU -source-level debugger. It includes support for heterogenous debugging on the -ROCm platform of an x86-based host architecture together with the AMD -commercially available GPU architectures supported by the AMD Debugger API which -is included with the ROCm release as the ROCdbgapi library. - -Standard GDB commands can be used for both CPU and GPU code debugging. For more -information about ROCgdb, please refer to the *ROCgdb User Manual* which is -installed as both texinfo files and as a single PDF file in -``/opt/rocm/share/doc/gdb`. In particular, refer to the *Debugging Heterogeneous -Programs* chapter for general information, and the *AMD GPU* subsection of the -*Architectures* section in the *Configuration-Specific Information* chapter. The -*AMD GPU* subsection also provides the list of features not currently -implemented, and known current restrictions. - -For more information about ROCm, please refer to: +The ROCm Debugger (ROCgdb) is the ROCm source-level debugger for Linux, based on +the GNU Debugger (GDB). It enables heterogenous debugging on the ROCm platform +of an x86-based host architecture along with AMD GPU architectures supported by +the AMD Debugger API Library (ROCdbgapi). The AMD Debugger API Library +(ROCdbgapi) is included with the ROCm release. + +The current ROCm Debugger (ROCgdb) is an initial prototype that focusses on +source line debugging and does not provide symbolic variable debugging +capabilities. The user guide presents features and commands that may be +implemented in future versions. + +For more information about ROCm, see: - https://github.com/RadeonOpenCompute/ROCm -For more information about GDB, please refer to the README file in this folder -or check the GDB home page at: +You can use the standard GDB commands for both CPU and GPU code debugging. For +more information about ROCgdb, refer to the *ROCgdb User Guide* which is +installed at: + +- ``/opt/rocm/share/info/gdb.info`` as a texinfo file +- ``/opt/rocm/share/doc/gdb/gdb.pdf`` as a PDF file + +You can refer to the following chapters in the *ROCgdb User Guide* for more +specific information about debugging heterogenous programs on ROCm: + +- *Debugging Heterogeneous Programs* provides general information about + debugging heterogenous programs. +- *Configuration-Specific Information > Architectures > AMD GPU* provides + specific information about debugging heterogenous programs on ROCm with + supported AMD GPU chips. This section also lists the features, commands, and + known issues that may be implemented and resolved in future releases. + +For more information about the GNU Debugger (GDB), refer to the ``README`` file +in this folder or check the GNU Debugger (GDB) web site at: - http://www.gnu.org/software/gdb diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index b84c07441d4..53e367b8592 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -3378,7 +3378,7 @@ Turns on or off display of @code{libthread_db}-related events. Use @code{1} to enable, @code{0} to disable. @end table -@xref{Heterogeneous Debugging} for additional infomation related to +@xref{Heterogeneous Debugging} for additional information related to threads in heterogeneous systems. @node Forks