summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
author Firehawke <34792592+Firehawke@users.noreply.github.com>2018-02-05 02:27:02 -0700
committer Vas Crabb <cuavas@users.noreply.github.com>2018-02-05 20:27:02 +1100
commitb2e11d00e04db9d62fc2c2c8d50b797c28fcd4a9 (patch)
treebb4b27adebb278114a4155338e645ca0fa6b22af /docs
parent18835562189492bd15263dba9d0ea5175cc6221c (diff)
More docs work: escapes, debugger update (nw) (#3168)
* Missed a couple escape sequences. (nw) * A little more escaping, acronym fixes, fix oddity in symlist (nw) * Update debugger internal help to match docs (nw) * Lowercasing for CPU in command parameters, fix casing on ASCII. (nw)
Diffstat (limited to 'docs')
-rw-r--r--docs/source/debugger/breakpoint.rst2
-rw-r--r--docs/source/debugger/cheats.rst2
-rw-r--r--docs/source/debugger/expressions.rst2
-rw-r--r--docs/source/debugger/general.rst18
-rw-r--r--docs/source/debugger/watchpoint.rst2
-rw-r--r--docs/source/tools/imgtool.rst34
6 files changed, 28 insertions, 32 deletions
diff --git a/docs/source/debugger/breakpoint.rst b/docs/source/debugger/breakpoint.rst
index 260a66444de..a87530f6953 100644
--- a/docs/source/debugger/breakpoint.rst
+++ b/docs/source/debugger/breakpoint.rst
@@ -34,7 +34,7 @@ bpset
|
| Set a breakpoint that will halt execution whenever the PC is equal to 23456 AND the expression (a0 == 0 && a1 == 0) is true.
|
-| bp 3456,1,{printf "A0=%08X\n",a0; g}
+| bp 3456,1,{printf "A0=%08X\\n",a0; g}
|
| Set a breakpoint that will halt execution whenever the PC is equal to 3456. When this happens, print A0=<a0val> and continue executing.
|
diff --git a/docs/source/debugger/cheats.rst b/docs/source/debugger/cheats.rst
index c725136f516..1b6764c8e79 100644
--- a/docs/source/debugger/cheats.rst
+++ b/docs/source/debugger/cheats.rst
@@ -22,7 +22,7 @@ cheatinit
|
| The cheatinit command initializes the cheat search to the selected memory area.
|
-| If no parameter is specified the cheat search is initialized to all changeable memory of the main cpu.
+| If no parameter is specified the cheat search is initialized to all changeable memory of the main CPU.
|
| <sign> can be s(signed) or u(unsigned)
| <width> can be b(8 bit), w(16 bit), d(32 bit) or q(64 bit)
diff --git a/docs/source/debugger/expressions.rst b/docs/source/debugger/expressions.rst
index 5bc448ba105..5014eeb1791 100644
--- a/docs/source/debugger/expressions.rst
+++ b/docs/source/debugger/expressions.rst
@@ -42,7 +42,7 @@ Differences from C Behaviors
- Similarly, **w@** and **w!** refer to a *word* in memory, **d@** and **d!** refer to a *dword* in memory, and **q@** and **q!** refer to a *qword* in memory.
- The memory operators can be used as both lvalues and rvalues, so you can write b\@100 = ff to store a byte in memory. By default these operators read from the program memory space, but you can override that by prefixing them with a 'd' or an 'i'.
+ The memory operators can be used as both lvalues and rvalues, so you can write **b\@100 = ff** to store a byte in memory. By default these operators read from the program memory space, but you can override that by prefixing them with a 'd' or an 'i'.
As such, **dw\@300** refers to data memory word at address 300 and **id\@400** refers to an I/O memory dword at address 400.
diff --git a/docs/source/debugger/general.rst b/docs/source/debugger/general.rst
index 441374ae456..79698938e49 100644
--- a/docs/source/debugger/general.rst
+++ b/docs/source/debugger/general.rst
@@ -16,7 +16,7 @@ You can also type **help <command>** for further details on each command in the
| :ref:`debugger-command-tracelog` -- outputs one or more <item>s to the trace file using <format>
| :ref:`debugger-command-tracesym` -- outputs one or more <item>s to the trace file
| history -- outputs a brief history of visited opcodes (**to fix: help missing for this command**)
-| :ref:`debugger-command-trackpc` -- visually track visited opcodes [boolean to turn on and off, for the given cpu, clear]
+| :ref:`debugger-command-trackpc` -- visually track visited opcodes [boolean to turn on and off, for the given CPU, clear]
| :ref:`debugger-command-trackmem` -- record which PC writes to each memory address [boolean to turn on and off, clear]
| :ref:`debugger-command-pcatmem` -- query which PC wrote to a given memory address for the current CPU
| :ref:`debugger-command-rewind` -- go back in time by loading the most recent rewind state
@@ -215,10 +215,6 @@ tracesym
|
| Outputs PC=<pcval> where <pcval> is displayed in the default format.
|
-| printf a,b
-|
-| Outputs A=<aval>, B=<bval> on one line.
-|
| Back to :ref:`debugger-general-list`
@@ -229,17 +225,17 @@ trackpc
| **trackpc [<bool>,<cpu>,<bool>]**
|
-| The trackpc command displays which program counters have already been visited in all disassembler windows. The first boolean argument toggles the process on and off. The second argument is a cpu selector; if no cpu is specified, the current cpu is automatically selected. The third argument is a boolean denoting if the existing data should be cleared or not.
+| The trackpc command displays which program counters have already been visited in all disassembler windows. The first boolean argument toggles the process on and off. The second argument is a CPU selector; if no CPU is specified, the current CPU is automatically selected. The third argument is a boolean denoting if the existing data should be cleared or not.
|
| Examples:
|
| trackpc 1
|
-| Begin tracking the current cpu's pc.
+| Begin tracking the current CPU's pc.
|
| trackpc 1, 0, 1
|
-| Continue tracking pc on cpu 0, but clear existing track info.
+| Continue tracking pc on CPU 0, but clear existing track info.
|
| Back to :ref:`debugger-general-list`
@@ -251,7 +247,7 @@ trackmem
| **trackmem [<bool>,<cpu>,<bool>]**
|
-| The trackmem command logs the PC at each time a memory address is written to. The first boolean argument toggles the process on and off. The second argument is a cpu selector; if no cpu is specified, the current cpu is automatically selected. The third argument is a boolean denoting if the existing data should be cleared or not. Please refer to the pcatmem command for information on how to retrieve this data. Also, right clicking in a memory window will display the logged PC for the given address.
+| The trackmem command logs the PC at each time a memory address is written to. The first boolean argument toggles the process on and off. The second argument is a CPU selector; if no CPU is specified, the current CPU is automatically selected. The third argument is a boolean denoting if the existing data should be cleared or not. Please refer to the pcatmem command for information on how to retrieve this data. Also, right clicking in a memory window will display the logged PC for the given address.
|
| Examples:
|
@@ -261,7 +257,7 @@ trackmem
|
| trackmem 1, 0, 1
|
-| Continue tracking memory writes on cpu 0, but clear existing track info.
+| Continue tracking memory writes on CPU 0, but clear existing track info.
|
| Back to :ref:`debugger-general-list`
@@ -277,7 +273,7 @@ pcatmem
| **pcatmemd <address>[,<cpu>]** -- query which PC wrote to a given data memory address for the current CPU
| **pcatmemi <address>[,<cpu>]** -- query which PC wrote to a given I/O memory address for the current CPU (you can also query this info by right clicking in a memory window)
|
-| The pcatmem command returns which PC wrote to a given memory address for the current CPU. The first argument is the requested address. The second argument is a cpu selector; if no cpu is specified, the current cpu is automatically selected. Right clicking in a memory window will also display the logged PC for the given address.
+| The pcatmem command returns which PC wrote to a given memory address for the current CPU. The first argument is the requested address. The second argument is a CPU selector; if no CPU is specified, the current CPU is automatically selected. Right clicking in a memory window will also display the logged PC for the given address.
|
| Examples:
|
diff --git a/docs/source/debugger/watchpoint.rst b/docs/source/debugger/watchpoint.rst
index 0d92b582bf7..22a0d8e7c92 100644
--- a/docs/source/debugger/watchpoint.rst
+++ b/docs/source/debugger/watchpoint.rst
@@ -38,7 +38,7 @@ wpset
|
| Set a watchpoint that will halt execution whenever a write occurs in the address range 23456-2345f AND the data written is equal to 1.
|
-| wp 3456,20,r,1,{printf "Read @ %08X\n",wpaddr; g}
+| wp 3456,20,r,1,{printf "Read @ %08X\\n",wpaddr; g}
|
| Set a watchpoint that will halt execution whenever a read occurs in the address range 3456-3475. When this happens, print Read @ <wpaddr> and continue executing.
|
diff --git a/docs/source/tools/imgtool.rst b/docs/source/tools/imgtool.rst
index 7edac078db5..b874fdfe215 100644
--- a/docs/source/tools/imgtool.rst
+++ b/docs/source/tools/imgtool.rst
@@ -3,9 +3,9 @@ Imgtool - *A generic image manipulation tool for MAME*
-Imgtool is a tool for the maintenance and manipulation of disk and other types of images that MAME users need to deal with. Functions include retrieving and storing files and CRC checking/validation.
+Imgtool is a tool for the maintenance and manipulation of disk and other types of images that MAME users need to deal with. Functions include retrieving and storing files and CRC checking/validation.
-Imgtool is part of the MAME project. It shares large portions of code with MAME, and its existence would not be if it were not for MAME. As such, the distribution terms are the same as MAME. Please read the MAME license thoroughly.
+Imgtool is part of the MAME project. It shares large portions of code with MAME, and its existence would not be if it were not for MAME. As such, the distribution terms are the same as MAME. Please read the MAME license thoroughly.
**Some portions of Imgtool are Copyright (c) 1989, 1993 The Regents of the University of California. All rights reserved.**
@@ -462,7 +462,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
Image specific creation options (usable on the 'create' command):
@@ -512,7 +512,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
Image specific creation options (usable on the 'create' command):
@@ -582,7 +582,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
@@ -622,7 +622,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -706,7 +706,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -769,7 +769,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -853,7 +853,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -889,7 +889,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -973,7 +973,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -1009,7 +1009,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -1093,7 +1093,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -1146,7 +1146,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -1230,7 +1230,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options
@@ -1376,7 +1376,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
@@ -1461,7 +1461,7 @@ Image specific file options (usable on the 'put' command):
Option Allowed values Description
---------------- ------------------------------ -------------------------------------------------------------
--ftype basic/data/binary/assembler File type
---ascii ascii/binary Ascii flag
+--ascii ascii/binary ASCII flag
================ ============================== =============================================================
No image specific creation options