Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
- Update README-ROCM.md
- Remove unnecessary @indent from gdb.texinfo copyright block
- Correct spelling mistake in gdb.texinfo

Change-Id: I56dde693570119683bfcc86d85ae8eebe522eff5
  • Loading branch information
t-tye committed Feb 6, 2020
1 parent 39bd3a2 commit 222288a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 19 deletions.
49 changes: 31 additions & 18 deletions README-ROCM.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion gdb/doc/gdb.texinfo
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 222288a

Please sign in to comment.