summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/debugger/general.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/debugger/general.rst')
-rw-r--r--docs/source/debugger/general.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/source/debugger/general.rst b/docs/source/debugger/general.rst
index db1a1933149..9d7d206117e 100644
--- a/docs/source/debugger/general.rst
+++ b/docs/source/debugger/general.rst
@@ -3,6 +3,8 @@
General Debugger Commands
=========================
+:ref:`debugger-command-help`
+ displays built-in help in the console
:ref:`debugger-command-do`
evaluates the given expression
:ref:`debugger-command-symlist`
@@ -43,6 +45,30 @@ General Debugger Commands
exit the debugger and end the emulation session
+.. _debugger-command-help:
+
+help
+----
+
+**help [<topic>]**
+
+Displays built-in debugger help in the debugger console. If no
+**<topic>** is specified, top-level topics are listed. Most debugger
+commands have correspondingly named help topics.
+
+Examples:
+
+``help``
+ Lists top-level help topics.
+``help expressions``
+ Displays built-in help for debugger expression syntax.
+``help wpiset``
+ Displays built-in help for the
+ :ref:`wpiset <debugger-command-wpset>` command.
+
+Back to :ref:`debugger-general-list`
+
+
.. _debugger-command-do:
do