From 8f8c85250c48062ae5a474a10a64c28c5fdb2e2c Mon Sep 17 00:00:00 2001 From: stephena Date: Wed, 26 Jun 2013 16:03:08 +0000 Subject: [PATCH] Preparation for 3.9 release, updated documentation. git-svn-id: svn://svn.code.sf.net/p/stella/code/trunk@2756 8b62c5a3-ac7e-4cc8-8f21-d9a121418aba --- Announce.txt | 26 ++-- Changes.txt | 8 +- debian/changelog | 7 + docs/debugger.html | 130 +++++++++---------- docs/graphics/debugger_bankcomplex.png | Bin 0 -> 9087 bytes docs/graphics/debugger_banksimple.png | Bin 0 -> 3374 bytes docs/graphics/debugger_iotab.png | Bin 8473 -> 8553 bytes docs/graphics/debugger_main.png | Bin 33300 -> 31786 bytes docs/graphics/debugger_ram.png | Bin 5767 -> 6052 bytes docs/graphics/debugger_ramsearch.png | Bin 5191 -> 5698 bytes docs/graphics/debugger_rom.png | Bin 9965 -> 9381 bytes docs/graphics/debugger_romcmenu.png | Bin 6874 -> 10176 bytes docs/graphics/debugger_tiainfo.png | Bin 1635 -> 1741 bytes docs/graphics/debugger_tiatab.png | Bin 9937 -> 9414 bytes docs/graphics/eventmapping_devsports.png | Bin 7450 -> 6615 bytes docs/graphics/launcher_options_files.png | Bin 8512 -> 5270 bytes docs/graphics/launcher_options_snapshots.png | Bin 0 -> 5814 bytes docs/graphics/logs.png | Bin 9624 -> 9318 bytes docs/graphics/options.png | Bin 3652 -> 4267 bytes docs/graphics/options_audio.png | Bin 3189 -> 3170 bytes docs/graphics/options_video.png | Bin 9260 -> 8497 bytes docs/graphics/options_video_tv.png | Bin 8533 -> 8015 bytes docs/graphics/rom_browser.png | Bin 3644 -> 4953 bytes docs/index.html | 53 +++++--- src/debugger/CartDebug.cxx | 8 +- src/emucore/CompuMate.hxx | 2 +- src/emucore/Settings.cxx | 1 - src/gui/OptionsDialog.cxx | 4 +- src/gui/OptionsDialog.hxx | 2 +- src/macosx/Info-Stella.plist | 2 +- src/unix/stella.spec | 5 +- src/win32/stella.rc | 8 +- 32 files changed, 143 insertions(+), 113 deletions(-) create mode 100644 docs/graphics/debugger_bankcomplex.png create mode 100644 docs/graphics/debugger_banksimple.png create mode 100644 docs/graphics/launcher_options_snapshots.png diff --git a/Announce.txt b/Announce.txt index c17b6a108..ed60325e9 100644 --- a/Announce.txt +++ b/Announce.txt @@ -9,7 +9,7 @@ SSSS ttt eeeee llll llll aaaaa =========================================================================== - Release 3.8.1 for Linux, MacOSX and Windows + Release 3.9 for Linux, MacOSX and Windows =========================================================================== The Atari 2600 Video Computer System (VCS), introduced in 1977, was the @@ -21,28 +21,28 @@ all of your favourite Atari 2600 games again! Stella was originally developed for Linux by Bradford W. Mott, however, it has been ported to a number of other platforms and is currently maintained by Stephen Anthony. -This is the 3.8.1 release of Stella for Linux, Mac OSX and Windows. The +This is the 3.9 release of Stella for Linux, Mac OSX and Windows. The distributions currently available are: - * Binaries for Windows XP/Vista/7 : - Stella-3.8.1-win32.exe (32-bit EXE installer) - Stella-3.8.1-x64.exe (64-bit EXE installer) - Stella-3.8.1-windows.zip (32/64 bit versions) + * Binaries for Windows XP/Vista/7/8 : + Stella-3.9-win32.exe (32-bit EXE installer) + Stella-3.9-x64.exe (64-bit EXE installer) + Stella-3.9-windows.zip (32/64 bit versions) * Binary distribution for MacOS X 32-bit & 64-bit : - Stella-3.8.1-macosx.dmg (32-bit Universal Binary) - Stella-3.8.1_intel-macosx.dmg (32/64-bit Intel/OSX 10.6+) + Stella-3.9-macosx.dmg (32-bit Universal Binary) + Stella-3.9_intel-macosx.dmg (32/64-bit Intel/OSX 10.6+) * Binary distribution in 32-bit & 64-bit Ubuntu DEB format : - stella_3.8.1-1_i386.deb - stella_3.8.1-1_amd64.deb + stella_3.9-1_i386.deb + stella_3.9-1_amd64.deb * Binary distribution in 32-bit & 64-bit RPM format : - stella-3.8.1-2.i386.rpm - stella-3.8.1-2.x86_64.rpm + stella-3.9-2.i386.rpm + stella-3.9-2.x86_64.rpm * Source code distribution for all platforms : - stella-3.8.1-src.tar.gz + stella-3.9-src.tar.gz Distribution Site diff --git a/Changes.txt b/Changes.txt index fdbe71dc9..57304fe79 100644 --- a/Changes.txt +++ b/Changes.txt @@ -12,7 +12,7 @@ Release History =========================================================================== -3.8.1 to 3.9: (June xx, 2013) +3.8.1 to 3.9: (June 27, 2013) * Greatly extended functionality of the debugger disassembly: - There is now a new tab which lists information specific to the @@ -59,7 +59,8 @@ specifying whether snapshots should be saved using either the internal ROM database name or the actual ROM filename. This feature was present in older releases of Stella, and due to popular demand it's - now back again. + now back again. Related to this, added a new dialog specifically for + the numerous snapshot-related items. * Fixed bug in Linux/OSX versions when starting Stella for the first time; it was previously creating mislabeled directories to store @@ -76,6 +77,9 @@ RAM containing all zeroes. This seems to fix issues with Dragonstomper always starting in exactly the same state. + * Fixed issue when debugging CompuMate ROMs; keystrokes entering while + debugging would be interpreted as typing on the CompuMate keyboard. + * Changed colour of the 'current PC indicator' in the debugger to match the one used for line selection. This makes it easier to see for those with problems seeing lighter colours. diff --git a/debian/changelog b/debian/changelog index 719ab4086..c8e42c959 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,10 @@ +stella (3.9-1) stable; urgency=high + + * Version 3.9 release + + -- Stephen Anthony Thu, 27 Jun 2013 17:20:07 -0330 + + stella (3.8.1-1) stable; urgency=high * Version 3.8.1 release diff --git a/docs/debugger.html b/docs/debugger.html index b53eeeb8d..53dfb0aa3 100644 --- a/docs/debugger.html +++ b/docs/debugger.html @@ -67,6 +67,10 @@ feature that no other 2600 debugger has; it's completely cross-platform.<
  • Symbolic names in disassembly.
  • Symbolic names accepted as input.
    • + +
  • Ability to generate DASM-compatible disassembly files (currently single-bank + only) with all the features mentioned above.
    • +
  • Tab completion for commands, symbol names and functions.
  • Graphical editor for RIOT and extended RAM. Acts a lot like a spreadsheet. Input in hex, with displays for label/decimal/binary for @@ -647,9 +651,9 @@ can also get rid of all traps at once with the "cleartraps" command.

    listconfig - List Distella config directives [bank xx] listfunctions - List user-defined functions listtraps - List traps - loadconfig - Load Distella config file [from file xx] + loadconfig - Load Distella config file loadstate - Load emulator state xx (0-9) - loadsym - Load symbol file named xx + loadsym - Load symbol file n - Negative Flag: set (0 or 1), or toggle (no arg) pc - Set Program Counter to address xx pgfx - Mark 'PGFX' range in disassembly @@ -665,8 +669,9 @@ listfunctions - List user-defined functions runtopc - Run until PC is set to value xx s - Set Stack Pointer to value xx save - Save breaks, watches, traps to file xx - saveconfig - Save Distella config file [to file xx] - saverom - Save (possibly patched) ROM to file xx + saveconfig - Save Distella config file + savedis - Save Distella disassembly + saverom - Save (possibly patched) ROM saveses - Save console session to file xx savestate - Save emulator state xx (valid args 0-9) scanline - Advance emulation by xx scanlines (default=1) @@ -915,7 +920,7 @@ these cases, the values shown may not always be for RAM, and may point to ROM instead. In the latter case, the data cannot be modified.

    The 'Undo' button in the upper right should be self-explanatory; it will -undo the most previous operation to one cell only. The 'Rev' button is +undo the most previous operation to one cell only. The 'Revert' button is more comprehensive. It will undo all operations on all cells since you first made a change.

    The UI objects at the bottom refer to the currently selected RAM cell. @@ -931,38 +936,37 @@ The remaining buttons to the right are further explained in section (L).

    energy, but it's also very useful when debugging to determine which memory location holds which quantity.

    -

    To search RAM, click 'Srch' and enter a byte value into the search editbox (0-255). +

    To search RAM, click 'Search' and enter a byte value into the search editbox (0-255). All matching values will be highlighted in the RAM widget. If 'Search' is clicked and the input is empty, all RAM locations are highlighted.

    -

    The 'Cmp' button is used to compare the given value using all +

    The 'Compare' button is used to compare the given value using all addresses currently highlighted. This may be an absolute number (such as 2), or a comparitive number (such as -1). Using a '+' or '-' operator means 'search addresses for values that have changed by that amount'.

    -

    The 'Rset' button resets the entire operation; it clears the highlighted +

    The 'Reset' button resets the entire operation; it clears the highlighted addresses and allows another search.

    The following is an example of inspecting all addresses that have decreased by 1:

      -
    • Click 'Srch' with empty input. All address/values are highlighted
      • +
    • Click 'Search' with empty input. All address/values are highlighted
    • Exit debugger mode and lose a life, let your energy decrease, or do whatever it is you're trying to debug
      • -
    • Enter debugger mode again, click 'Cmp' and and enter a '-1' for input. +
    • Enter debugger mode again, click 'Compare' and and enter a '-1' for input. This finds all values that have decreased by 1 (as compared to their current values)
    • Repeatedly following these steps may help to narrow number of addresses under consideration, and eventually you'll find the memory address you're looking for
      • -
    • Click 'Rset' when you're finished
      • +
    • Click 'Reset' when you're finished

    -

    (M) ROM Listing

    -

    The ROM Widget is a disassembly of the current bank of ROM. If a symbol -file is loaded, the disassembly will have labels. Even without a symbol file, the standard -TIA/RIOT labels will still be present.

    +

    (M) ROM Disassembly

    +

    This area contains a disassembly of the current bank of ROM. If a symbol +file is loaded, the disassembly will have labels. Even without a symbol file, the standard TIA/RIOT labels will still be present.

    The disassembly is often quite extensive, and whenever possible tries to automatically differentiate between code, graphics, data and unused bytes. There are actually two levels of disassembly in Stella. First, the emulation core tracks accesses as a game @@ -981,26 +985,10 @@ a relative jump are in fact code, or simply data.

    -

    The top area contains two items: -

      -
    • Current bank (x total): Shows the current bank in use (number in textbox), -and the total number of banks (x). Note that bank numbers start at 0 (as in most -programming languages). If the cartridge contains multiple banks, the bank can -be changed in the bank textbox, and the ROM will be re-disassembled. -Note that certain ROMs are quite complex, and may only show has having one -'virtual' bank when their address space can be swapped in and out in many -different ways.
      • -
    • Resolve data: Informs Distella about the 'resolvedata' -commandline argument, which says how code and data sections are disassembled. -If set to 'Never', the entire address space is treated as code. If set to -'Always', an attempt is always made to resolve data sections. -The 'Automatic' setting is a combination of the previous two. First, an -attempt is made to resolve data sections. If this results in the current program -counter not being present in the disassembly, then a second disassembly is -done, without resolving data sections. Note that this option applies only to -addresses determined by Distella; addresses marked as code or graphics by the -emulation core will stay as such, no matter what this setting says.
      • -
    +

    The "Bank state" is self-explanatory, and shows a summary of the current +bank information. For normal bankswitched ROMs, this will be the current bank number, +however more advanced schemes will show other types of information here. More detailed +information is available in Detailed Bankswitch Information (N).

    Each line of disassembly has four fields: