summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/debugger
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2018-07-22 09:52:50 +1000
committer Vas Crabb <vas@vastheman.com>2018-07-22 09:52:50 +1000
commit6669489679753daa8c5766ae24b31b0ce0748221 (patch)
treed387975a23867ee4650f45cd33bfc518c64d3288 /docs/source/debugger
parent7809e9005dff6769ad18cf924f285fd60519b044 (diff)
allow repeating elements and groups - useful if you need e.g. a lot of numbered labels, but it limits complay.py's ability to check for invalid references as it can't evaluate expressions (nw)
Diffstat (limited to 'docs/source/debugger')
-rw-r--r--docs/source/debugger/breakpoint.rst4
-rw-r--r--docs/source/debugger/execution.rst14
-rw-r--r--docs/source/debugger/general.rst18
-rw-r--r--docs/source/debugger/memory.rst18
-rw-r--r--docs/source/debugger/watchpoint.rst6
5 files changed, 30 insertions, 30 deletions
diff --git a/docs/source/debugger/breakpoint.rst b/docs/source/debugger/breakpoint.rst
index a87530f6953..7dede5475be 100644
--- a/docs/source/debugger/breakpoint.rst
+++ b/docs/source/debugger/breakpoint.rst
@@ -20,8 +20,8 @@ bpset
| **bp[set] <address>[,<condition>[,<action>]]**
|
-| Sets a new execution breakpoint at the specified <address>.
-| The optional <condition> parameter lets you specify an expression that will be evaluated each time the breakpoint is hit. If the result of the expression is true (non-zero), the breakpoint will actually halt execution; otherwise, execution will continue with no notification.
+| Sets a new execution breakpoint at the specified <address>.
+| The optional <condition> parameter lets you specify an expression that will be evaluated each time the breakpoint is hit. If the result of the expression is true (non-zero), the breakpoint will actually halt execution; otherwise, execution will continue with no notification.
| The optional <action> parameter provides a command that is executed whenever the breakpoint is hit and the <condition> is true. Note that you may need to embed the action within braces { } in order to prevent commas and semicolons from being interpreted as applying to the bpset command itself. Each breakpoint that is set is assigned an index which can be used in other breakpoint commands to reference this breakpoint.
|
| Examples:
diff --git a/docs/source/debugger/execution.rst b/docs/source/debugger/execution.rst
index dc8a52abd43..fd2cc597f26 100644
--- a/docs/source/debugger/execution.rst
+++ b/docs/source/debugger/execution.rst
@@ -156,7 +156,7 @@ gtime
-----
| **gt[ime] <milliseconds>**
-|
+|
| The gtime command resumes execution of the current code. Control will not be returned to the debugger until a specified delay has elapsed. The delay is in milliseconds.
|
| Example:
@@ -186,7 +186,7 @@ focus
-----
| **focus <cpu>**
-|
+|
| Sets the debugger focus exclusively to the given <cpu>. This is equivalent to specifying 'ignore' on all other CPUs.
|
| Example:
@@ -257,13 +257,13 @@ trace
| **trace {<filename>|OFF}[,<cpu>[,[noloop|logerror][,<action>]]]**
|
-| Starts or stops tracing of the execution of the specified <cpu>. If <cpu> is omitted, the currently active CPU is specified.
+| Starts or stops tracing of the execution of the specified <cpu>. If <cpu> is omitted, the currently active CPU is specified.
|
| When enabling tracing, specify the filename in the <filename> parameter. To disable tracing, substitute the keyword 'off' for <filename>.
|
-| <detectloops> should be either true or false.
+| <detectloops> should be either true or false.
|
-| If 'noloop' is omitted, the trace will have loops detected and condensed to a single line. If 'noloop' is specified, the trace will contain every opcode as it is executed.
+| If 'noloop' is omitted, the trace will have loops detected and condensed to a single line. If 'noloop' is specified, the trace will contain every opcode as it is executed.
|
| If 'logerror' is specified, logerror output will augment the trace. If you wish to log additional information on each trace, you can append an <action> parameter which is a command that is executed before each trace is logged. Generally, this is used to include a 'tracelog' command. Note that you may need to embed the action within braces { } in order to prevent commas and semicolons from being interpreted as applying to the trace command itself.
|
@@ -314,9 +314,9 @@ traceover
|
| Starts or stops tracing of the execution of the specified <cpu>.
|
-| When tracing reaches a subroutine or call, tracing will skip over the subroutine. The same algorithm is used as is used in the step over command. This means that traceover will not work properly when calls are recursive or the return address is not immediately following the call instruction.
+| When tracing reaches a subroutine or call, tracing will skip over the subroutine. The same algorithm is used as is used in the step over command. This means that traceover will not work properly when calls are recursive or the return address is not immediately following the call instruction.
|
-| <detectloops> should be either true or false. If <detectloops> is *true or omitted*, the trace will have loops detected and condensed to a single line. If it is false, the trace will contain every opcode as it is executed.
+| <detectloops> should be either true or false. If <detectloops> is *true or omitted*, the trace will have loops detected and condensed to a single line. If it is false, the trace will contain every opcode as it is executed.
| If <cpu> is omitted, the currently active CPU is specified.
| When enabling tracing, specify the filename in the <filename> parameter.
| To disable tracing, substitute the keyword 'off' for <filename>.
diff --git a/docs/source/debugger/general.rst b/docs/source/debugger/general.rst
index 79698938e49..752ec677841 100644
--- a/docs/source/debugger/general.rst
+++ b/docs/source/debugger/general.rst
@@ -33,11 +33,11 @@ do
--
| **do <expression>**
-|
+|
| The do command simply evaluates the given <expression>. This is typically used to set or modify variables.
-|
+|
| Examples:
-|
+|
| do pc = 0
|
| Sets the register 'pc' to 0.
@@ -50,7 +50,7 @@ symlist
-------
| **symlist [<cpu>]**
-|
+|
| Lists registered symbols. If <cpu> is not specified, then symbols in the global symbol table are displayed; otherwise, the symbols for <cpu>'s specific CPU are displayed. Symbols are listed alphabetically. Read-only symbols are flagged with an asterisk.
|
| Examples:
@@ -67,7 +67,7 @@ symlist
.. _debugger-command-softreset:
-
+
softreset
---------
@@ -85,7 +85,7 @@ softreset
.. _debugger-command-hardreset:
-
+
hardreset
---------
@@ -125,7 +125,7 @@ print
.. _debugger-command-printf:
-
+
printf
------
@@ -152,7 +152,7 @@ printf
.. _debugger-command-logerror:
-
+
logerror
--------
@@ -285,7 +285,7 @@ pcatmem
.. _debugger-command-rewind:
-
+
rewind
------
diff --git a/docs/source/debugger/memory.rst b/docs/source/debugger/memory.rst
index addbaf23dbe..7f9414e085f 100644
--- a/docs/source/debugger/memory.rst
+++ b/docs/source/debugger/memory.rst
@@ -71,11 +71,11 @@ dump
| **dump[{d|i}] <filename>,<address>,<length>[,<size>[,<ascii>[,<cpu>]]]**
|
-| The **dump**/**dumpd**/**dumpi** commands dump memory to the text file specified in the <filename> parameter.
+| The **dump**/**dumpd**/**dumpi** commands dump memory to the text file specified in the <filename> parameter.
| 'dump' will dump program space memory, while 'dumpd' will dump data space memory and 'dumpi' will dump I/O space memory.
-| <address> indicates the address of the start of dumping, and <length> indicates how much memory to dump. The range <address> through <address>+<length>-1 inclusive will be output to the file.
+| <address> indicates the address of the start of dumping, and <length> indicates how much memory to dump. The range <address> through <address>+<length>-1 inclusive will be output to the file.
| By default, the data will be output in byte format, unless the underlying address space is word/dword/qword-only. You can override this by specifying the <size> parameter, which can be used to group the data in 1, 2, 4 or 8-byte chunks.
-| The optional <ascii> parameter can be used to enable (1) or disable (0) the output of ASCII characters to the right of each line; by default, this is enabled.
+| The optional <ascii> parameter can be used to enable (1) or disable (0) the output of ASCII characters to the right of each line; by default, this is enabled.
| Finally, you can dump memory from another CPU by specifying the <cpu> parameter.
|
|
@@ -101,7 +101,7 @@ save
|
| The **save**/**saved**/**savei** commands save raw memory to the binary file specified in the <filename> parameter.
| 'save' will save program space memory, while 'saved' will save data space memory and 'savei' will save I/O space memory.
-| <address> indicates the address of the start of saving, and <length> indicates how much memory to save. The range <address> through <address>+<length>-1 inclusive will be output to the file.
+| <address> indicates the address of the start of saving, and <length> indicates how much memory to save. The range <address> through <address>+<length>-1 inclusive will be output to the file.
| You can also save memory from another CPU by specifying the <cpu> parameter.
|
|
@@ -125,10 +125,10 @@ load
| **load[{d|i}] <filename>,<address>[,<length>,<cpu>]**
|
-| The **load**/**loadd**/**loadi** commands load raw memory from the binary file specified in the <filename> parameter.
-| 'load' will load program space memory, while 'loadd' will load data space memory and 'loadi' will load I/O space memory.
-| <address> indicates the address of the start of saving, and <length> indicates how much memory to load. The range <address> through <address>+<length>-1 inclusive will be read in from the file.
-| If you specify <length> = 0 or a length greater than the total length of the file it will load the entire contents of the file and no more.
+| The **load**/**loadd**/**loadi** commands load raw memory from the binary file specified in the <filename> parameter.
+| 'load' will load program space memory, while 'loadd' will load data space memory and 'loadi' will load I/O space memory.
+| <address> indicates the address of the start of saving, and <length> indicates how much memory to load. The range <address> through <address>+<length>-1 inclusive will be read in from the file.
+| If you specify <length> = 0 or a length greater than the total length of the file it will load the entire contents of the file and no more.
| You can also load memory from another CPU by specifying the <cpu> parameter.
|
| NOTE: This will only actually write memory that is possible to overwrite in the Memory Window
@@ -154,7 +154,7 @@ map
| **map[{d|i}] <address>**
|
-| The map/mapd/mapi commands map a logical address in memory to the correct physical address, as well as specifying the bank.
+| The map/mapd/mapi commands map a logical address in memory to the correct physical address, as well as specifying the bank.
| 'map' will map program space memory, while 'mapd' will map data space memory and 'mapi' will map I/O space memory.
|
| Example:
diff --git a/docs/source/debugger/watchpoint.rst b/docs/source/debugger/watchpoint.rst
index 22a0d8e7c92..f80fa152197 100644
--- a/docs/source/debugger/watchpoint.rst
+++ b/docs/source/debugger/watchpoint.rst
@@ -19,12 +19,12 @@ wpset
| **wp[{d|i}][set] <address>,<length>,<type>[,<condition>[,<action>]]**
|
-| Sets a new watchpoint starting at the specified <address> and extending for <length>. The inclusive range of the watchpoint is <address> through <address> + <length> - 1.
+| Sets a new watchpoint starting at the specified <address> and extending for <length>. The inclusive range of the watchpoint is <address> through <address> + <length> - 1.
| The 'wpset' command sets a watchpoint on program memory; the 'wpdset' command sets a watchpoint on data memory; and the 'wpiset' sets a watchpoint on I/O memory.
| The <type> parameter specifies which sort of accesses to trap on. It can be one of three values: 'r' for a read watchpoint 'w' for a write watchpoint, and 'rw' for a read/write watchpoint.
|
-| The optional <condition> parameter lets you specify an expression that will be evaluated each time the watchpoint is hit. If the result of the expression is true (non-zero), the watchpoint will actually halt execution; otherwise, execution will continue with no notification.
-| The optional <action> parameter provides a command that is executed whenever the watchpoint is hit and the <condition> is true. Note that you may need to embed the action within braces { } in order to prevent commas and semicolons from being interpreted as applying to the wpset command itself.
+| The optional <condition> parameter lets you specify an expression that will be evaluated each time the watchpoint is hit. If the result of the expression is true (non-zero), the watchpoint will actually halt execution; otherwise, execution will continue with no notification.
+| The optional <action> parameter provides a command that is executed whenever the watchpoint is hit and the <condition> is true. Note that you may need to embed the action within braces { } in order to prevent commas and semicolons from being interpreted as applying to the wpset command itself.
| Each watchpoint that is set is assigned an index which can be used in other watchpoint commands to reference this watchpoint.
| In order to help <condition> expressions, two variables are available. For all watchpoints, the variable 'wpaddr' is set to the address that actually triggered the watchpoint. For write watchpoints, the variable 'wpdata' is set to the data that is being written.
|