docs/vj_ReleaseNotes.txt

   1 Release 4 (TBD)
   2 ---------------
   3 0) The zoom value setting has been fixed in the registry
   4 1) Debugger mode shares the same alpine rom path setting
   5
   6 Release 3 (13th November 2017)
   7 ------------------------------
   8 0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
   9 1) Added an Exception Vector Table browser window
  10 2) Modified the About window to update the credits list in a more appropriate way
  11 -- Updated the emulator application credits line
  12 3) Added 'Rx' word to the emulator name
  13 4) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
  14 5) Added ui, alpine & debugger groups in the settings
  15 6) Added the possibility to erase settings
  16 7) Added the --es-all, --es-ui, --es-alpine & --es-debugger options to erase specific settings
  17 8) Added a keybindings tab and adapted the configuration dialog tabs
  18 -- User can modify the keybindings where appropriate
  19 -- Keybindings UI is displayed based on the option used (--debugger, -- alpine)
  20 9) Fixed a crash, in Release mode, when the HW labels setting is turn on
  21 10) Solved an interference between the HW labels setting and the one used by the debugger
  22 -- The setting is now only the reference used
  23 11) Fixed the SP (Stack) window UI potential missing data
  24 12) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
  25 13) Keep the scrollbar position in accordance of the M68K PC pointer
  26 -- UI displays the source without the need to move down/up the scrollbar
  27 14) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
  28 -- This may come from the linker vlink
  29 15) Improved the .heap section detection to avoid a detection error
  30 -- Depend vlink version, .heap section may have an Alloc flag
  31 16) Fixed a crash when DWARF information does references to missing source code files
  32 17) Added a Local browser window for local variables
  33 18) Project has switched to Visual Studio 2017 and QT 5.9.1 library
  34
  35 Release 2 (3rd September 2017)
  36 ------------------------------
  37 0) Added some error detections when reading the ELF executable file
  38 1) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
  39 2) "Step Over" code function for BSR/JSR functions
  40 3) Added the .debug_ranges detection to avoid a detection error
  41 4) DWARF support
  42 -- TAG: Compilation Unit, Subprogram, Variables, Types
  43 -- Line numbers, symbols, functions
  44 5) Added an All Watch browser window for non-local variables
  45 6) Added a heap allocator browser window based on my own memory allocation functions
  46 7) Added additional 4 memory browser windows with address input based on hexa, decimal or symbol name
  47 8) Windows refreshing executed only if windows is visible
  48 9) Added a restart function
  49 -- Restart only the 68000 program counter to his original set
  50 10) Modified the icons color backgound for the "Step In" and "Step Over" functions
  51 11) Updated the About window to update the credits list
  52 12) 64 bits Release executable
  53 13) Fixed (hacking) the display of the SP (Stack) memory browser
  54 14) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
  55 -- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
  56 15) Added some information in the --help/-h/-? option
  57 16) --debugger option no longer force the log file
  58 17) Added a --dram-max option to extend the DRAM size to 8MB
  59 18) Added the "enter" key support when setting the BPM (Breapoint)
  60 19) Save the windows positions, size and visibilities (show or hide) status
  61 -- Such windows will automatically respawn in the next emulator launch
  62
  63 Release 1 (12th February 2017)
  64 ------------------------------
  65 0) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
  66 1) Clean-up the tracing / no-tracing flags for better U.I understanding
  67 2) Added SP (Stack) memory browser
  68 3) User can change now the number of lines of disassembly displayed in the tracing window
  69 4) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
  70 5) Added an emulator status window (GPU status, M68K debugger & tracking status)
  71 6) Added a GPU disassembly tracing window - Display the current PC pointer
  72 7) Added a DSP disassembly tracing window - Display the current PC pointer
  73 8) Added possibility to change refresh rate of browser windows when emulation is launched
  74 9) Display partial hardware labels (Internal Memory & Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
  75 -- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
  76 10) Minor U.I cosmetic changes
  77 11) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
  78 -- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
  79
  80 Release 0 (5th January 2017)
  81 ----------------------------
  82 0) New option --debugger
  83 1) ELF format support
  84 2) ELF debug symbol support
  85 3) "Step Into" code function
  86 4) Menus layout dedicated to the debugger
  87 5) Added a dedicated main window for tracing (M68K)
  88 6) Added a Debugger tab in the config tab
  89 7) Visual Studio 2015 project support
  90 8) libelf-0.8.13 library support
  91 9) 64 bits debug executable only
  92
  93
  94 Known issues
  95 ============
  96 1) Video output is not displayed due to my OpenGL / QT5 5.5.1 integration with VS 2015 but solved when using the QT 5.9.1 package for VS 2017
  97 2) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
  98 -- Need to trace over the BPM or unset the BPM
  99 3) To handle DWARF 2 issues with GCC, the code must be compiled with the -gdwarf-2 option
 100 4) The Local & Watch variables list may display not available (N/A) type information
 101 -- Such missing information may be included in future release
 102 5) The 2MB mirroring is no longer applied in case of --dram-max option usage
 103 6) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
 104 -- The application needs to set the SP (Stack) in accordance
 105 7) The Exception Vector Table broswer window displays only 65 vectors
 106 -- Missing vectors may be added in future release
 107 8) User needs to manualy check if the Atari Jaguar executable match his source code files
 108 -- Otherwise, source code and assembly may not match or leads to instabilities
 109 9) Application needs to be restarted in case of keybindings changes
 110
 111 Cosmetic / UX issues
 112 ====================
 113 1) The SP (Stack) icon color backgound doesn't look similar with the other ones
 114 2) The emulator status option has no icon
 115 3) The SP (Stack) window size always open at a forced size no matter if the size has been changed
 116 4) Not every features have associated keybindings
 117
 118 Legacy issues/hints
 119 ===================
 120 1) Emulator seems to have easter egg(s)
 121 -- The option --yarrr displays a single message and end the application
 122 -- Pressing F8, while in the main window, will create an extra message in the log file
 123 2) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
 124
 125 Project information
 126 ===================
 127 1) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
 128 2) Visual Studio 2015/2017 project support for 64 bits
 129 3) libelf 0.8.13 library 64bits for VS 2015/2017
 130 4) libdwarf 1.41 library 64bits for VS 2015/2017, cygwin64 & Msys2/MinGW64
 131 5) QT 5.5.1 library 64bits for VS 2015
 132 6) QT 5.9.1 library 64bits for VS 2017
 133 7) Zlib 1.2.8 library 64bits for VS 2015/2017
 134 8) SDL 1.2.15 library 64bits for VS 2015
 135 9) The original make files have been modified to follow the requirements and modifications
 136 10) The 'Rx' word has been added to the emulator name to make distinction with the official version
 137 11) The project source is set at https://github.com/djipi/Virtual-Jaguar-Rx
 138 12) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
 139 -- Text / License terms are the same
 140
 141
 142 Download statistics
 143 -------------------
 144 jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
 145 jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
 146 No downloads statistics available for the Release 2