Debugger documentation and screenshot updates.

This commit is contained in:
Stephen Anthony 2017-07-06 20:55:01 -02:30
parent f177aed814
commit 7f2b6a8983
19 changed files with 23 additions and 24 deletions

View File

@ -211,8 +211,10 @@ Bash-style commands are also supported:</p>
</table>
<p>You can also scroll with the mouse. Copy and paste is not yet supported.</p>
<p>To see the available commands, enter "help". Bash-style tab completion is
supported for commands, labels and functions (see below).</p>
<p>To see the available commands, enter "help". For extended help, type "help cmd",
where 'cmd' is the command you wish to know about. The available commands are listed
at the end of this section. Bash-style tab completion is supported for commands,
labels and functions (see below).</p>
<p>For now, there are some functions that only exist in the prompt. We
intend to add GUI equivalents for all (or almost all?) of the prompt
@ -619,13 +621,14 @@ can also get rid of all traps at once with the "cleartraps" command.</p>
<h3>Prompt commands:</h3>
<p>Type "help" to see this list in the debugger.</p>
<p>Type "help" to see this list in the debugger.<br/>
Type "help 'cmd'" to see extended information about the given command.</p>
<pre>
a - Set Accumulator to <value>
base - Set default base to <base>
break - Set/clear breakpoint at <address>
breakif - Set breakpoint on <condition>
a - Set Accumulator to &lt;value&gt;
base - Set default base to &lt;base&gt;
break - Set/clear breakpoint at &lt;address&gt;
breakif - Set breakpoint on &lt;condition&gt;
c - Carry Flag: set (0 or 1), or toggle (no arg)
cheat - Use a cheat code (see manual for cheat types)
clearbreaks - Clear all breakpoints
@ -639,17 +642,17 @@ can also get rid of all traps at once with the "cleartraps" command.</p>
data - Mark 'DATA' range in disassembly
debugcolors - Show Fixed Debug Colors information
define - Define label xx for address yy
delbreakif - Delete conditional breakif <xx>
delbreakif - Delete conditional breakif &lt;xx&gt;
delfunction - Delete function with label xx
delwatch - Delete watch <xx>
delwatch - Delete watch &lt;xx&gt;
disasm - Disassemble address xx [yy lines] (default=PC)
dump - Dump 128 bytes of memory at address <xx>
exec - Execute script file <xx>
dump - Dump 128 bytes of memory at address &lt;xx&gt;
exec - Execute script file &lt;xx&gt;
exitrom - Exit emulator, return to ROM launcher
frame - Advance emulation by <xx> frames (default=1)
frame - Advance emulation by &lt;xx&gt; frames (default=1)
function - Define function name xx for expression yy
gfx - Mark 'GFX' range in disassembly
help - help <command>
help - help &lt;command&gt;
jump - Scroll disassembly to address xx
listbreaks - List breakpoints
listconfig - List Distella config directives [bank xx]
@ -679,7 +682,7 @@ listfunctions - List user-defined functions
saveses - Save console session to file xx
savesnap - Save current TIA image to PNG file
savestate - Save emulator state xx (valid args 0-9)
scanline - Advance emulation by <xx> scanlines (default=1)
scanline - Advance emulation by &lt;xx&gt; scanlines (default=1)
step - Single step CPU [with count xx]
tia - Show TIA state
trace - Single step CPU over subroutines [with count xx]
@ -729,6 +732,7 @@ course, you can clear all the collisions with the CXCLR Strobe button.</p>
drawn in the current color. Changing a color register will change the
color of this rectangle.</p>
<p> <b>FIXME</b> - Christian and Thomas, you probably want to add something here ...</p>
<!-- ///////////////////////////////////////////////////////////////////////// -->
<br>
@ -766,10 +770,8 @@ video as generated by the TIA. If a complete frame hasn't been drawn,
the partial contents of the current frame will be displayed up to the
current scanline, with the contents of the old frame (in black &amp;
white) filling the rest of the display. Note that if 'phosphor mode'
has been enabled for a ROM, you will see the effect here as well. That
is, no flicker will be shown for 30Hz display, even though a real
system would alternate between drawing frames (and hence produce
flicker).</p>
or TV effects are enabled, you won't see the effects here; this shows the
raw TIA image only.</p>
<p>You can use the "Scan+1" button, the prompt "scan" command, or the
Control-L key to watch the TIA draw the frame one scanline at a time.</p>
@ -794,9 +796,6 @@ as illustrated:</p>
<li><b>Save snapshot</b>: Saves the TIA image currently shown,
including any current 'effects' (fixed debug colors, partial fill, etc).
</li>
<li><b>Toggle fixed debug colors</b>: Toggles fixed debug color mode.
Note that after this is toggled, the framebuffer must be updated in some way
(step/trace/frame advance) before the new colors are shown.</li>
</ul>
@ -805,13 +804,13 @@ as illustrated:</p>
<h2><u>(F)</u> TIA Info</h2>
<p>To the right of the TIA display (E) there is TIA information, as shown:</p>
<p><img src="graphics/debugger_tiainfo.png"></p>
<p>The indicators are as follows:</p>
<p>The indicators are as follows (note that all these are read-only):</p>
<ul>
<li><b>Frame Count</b>: The current frame number, since this ROM was loaded or reset.</li>
<li><b>Frame Cycle</b>: The number of CPU cycles that have been executed this frame, since
VSYNC was cleared at scanline 0.</li>
<li><b>Scanline</b>: The scanline that's currently being drawn. Scanline 0 is the one
on which VSYNC is cleared (after being set for 3 scanlines, as per the Stella
<li><b>Scanline</b>: The scanline that's currently being drawn, and the count from the
previous frame. Scanline 0 is the one on which VSYNC is cleared (after being set for 3 scanlines, as per the Stella
Programmer's Guide)</li>
<li><b>Scan Cycle</b>: The number of CPU cycles that have been executed since the beginning
of the current scanline.</li>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 430 B

After

Width:  |  Height:  |  Size: 469 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.4 KiB

After

Width:  |  Height:  |  Size: 2.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 784 B

After

Width:  |  Height:  |  Size: 783 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.6 KiB

After

Width:  |  Height:  |  Size: 8.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.2 KiB

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.9 KiB

After

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.9 KiB

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.9 KiB