summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/debugger/general.rst
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2021-10-14 08:00:04 +1100
committer Vas Crabb <vas@vastheman.com>2021-10-14 08:00:04 +1100
commit96ca1dbd965df08ed4ab1f23053690c9ce540f94 (patch)
tree7c357aa9efe72e7e9c8b6e7084cec9fa859e214a /docs/source/debugger/general.rst
parent75f9660fa29d3d68a522fa96dbc92ef02baff2b8 (diff)
More user experience improvements:
frontend: Allow clicking the adjuster arrows on menu items. This allows things like video options and DIP switches to be configured using a mouse only. Also fixed a bug preventing paging menus with a mouse if the first item scrolled off the bottom is not selectable. debugger: Allow wplist and bplist to accept a CPU argument to list breakpoints/watchpoints for a single CPU only. debugger: Fixed some corner cases in address space syntax in memory accesses, and allowed memory region accesses to use tags relative to the visible CPU. emu/softlist.cpp: Ignore notes elements when loading software lists. It's effectively a comment that isn't a comment syntactically, it's being used for things that are not useful to display in the internal UI, and it slows down startup. docs: Updated three more pages of debugger documentation. Also updated more of the built-in debugger help. minimaws: Fixed up schema for software list notes, made sofware list notes display initially collapsed.
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