Added a Local browser window for local variables
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_ReleaseNotes.txt
index d083f92..42bea30 100644 (file)
-Release 3 (TBC)
----------------
-0) Fixed the windows respawning in the next emulator launch without --alpine or --debugger options
-1) Added an Exception Vector Table browser window
-2) Modified the About window to update the credits list in a more appropriate way
--- Updated the emulator application credits line
-3) Added 'Rx' word to the emulator name to make distinction with the original version
-
-Release 2 (3rd September 2017)
-------------------------------
-0) Added some error detections when reading the ELF executable file
-1) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
-2) "Step Over" code function for BSR/JSR functions
-3) Added the .debug_ranges detection to avoid a detection error
-4) DWARF support
--- TAG: Compilation Unit, Subprogram, Variables, Types
--- Line numbers, symbols, functions
-5) Added an All Watch browser window for non-local variables
-6) Added a heap allocator browser window based on my own memory allocation functions
-7) Added additional 4 memory browser windows with address input based on hexa, decimal or symbol name
-8) Windows refreshing executed only if windows is visible
-9) Added a restart function
--- Restart only the 68000 program counter to his original set
-10) Modified the icons color backgound for the "Step In" and "Step Over" functions
-11) Updated the About window to update the credits list
-12) 64 bits Release executable
-13) Fixed (hacking) the display of the SP (Stack) memory browser
-14) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
--- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
-15) Added some information in the --help/-h/-? option
-16) --debugger option no longer force the log file
-17) Added a --dram-max option to extend the DRAM size to 8MB
-18) Added the "enter" key support when setting the BPM (Breapoint)
-19) Save the windows positions, size and visibilities (show or hide) status
--- Such windows will automatically respawn in the next emulator launch
-
-Release 1 (12th February 2017)
-------------------------------
-0) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
-1) Clean-up the tracing / no-tracing flags for better U.I understanding
-2) Added SP (Stack) memory browser
-3) User can change now the number of lines of disassembly displayed in the tracing window
-4) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
-5) Added an emulator status window (GPU status, M68K debugger & tracking status)
-6) Added a GPU disassembly tracing window - Display the current PC pointer
-7) Added a DSP disassembly tracing window - Display the current PC pointer
-8) Added possibility to change refresh rate of browser windows when emulation is launched
-9) Display partial hardware labels (Internal Memory & Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
--- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
-10) Minor U.I cosmetic changes
-11) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
--- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
-
-Release 0 (5th January 2017)
-----------------------------
-0) New option --debugger
-1) ELF format support
-2) ELF debug symbol support
-3) "Step Into" code function
-4) Menus layout dedicated to the debugger
-5) Added a dedicated main window for tracing (M68K)
-6) Added a Debugger tab in the config tab
-7) Visual Studio 2015 project support
-8) libelf-0.8.13 library support
-9) 64 bits debug executable only
-
-
-Known issues
-============
-1) Video output is not displayed due to OpenGL / QT5 integration problems with VS 2015
-2) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
--- Need to trace over the BPM or unset the BPM
-3) To handle DWARF 2 issues with GCC, the code must be compiled with the -gdwarf-2 option
-4) The Watch variables list may display not available (N/A) type information
--- Such missing information may be included in future release
-5) The 2MB mirroring is no longer applied in case of --dram-max option usage
-6) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
--- The application needs to set the SP (Stack) in accordance
-7) The Exception Vector Table broswer window displays only 65 vectors
--- Missing vectors may be added in future release
-
-Cosmetic / UX issues
-====================
-1) The SP (Stack) icon color backgound doesn't look similar with the other ones
-2) The emulator status option has no icon
-3) The SP (Stack) window size always open at a forced size no matter if the size has been changed
-
-Legacy issues/hints
-===================
-1) Emulator seems to have easter egg(s)
--- The option --yarrr displays a single message and end the application
-2) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
-
-Project information
-===================
-1) Code based on the Shamus Hammons source code available via Gethub by the 13th June 2016
-2) Visual Studio 2015 project support for 64 bits
-3) libelf 0.8.13 library 64bits for VS 2015
-4) libdwarf 1.41 library 64bits for VS 2015, cygwin64 & Msys2/MinGW64
-5) QT 5.5.1 library 64bits for VS 2015
-6) Zlib 1.2.8 library 64bits for VS 2015
-7) SDL 1.2.15 library 64bits for VS 2015
-8) The original make files have been modified to follow the requirements and modifications
-9) The 'Rx' word has been added to the emulator name to make distinction with the original version
-10) The project source is set at https://github.com/djipi/Virtual-Jaguar-Rx
-
-
-Download statistics
--------------------
-jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
-jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
-No downloads available for the Release 2
\ No newline at end of file
+Release 3 (WiP)\r
+---------------\r
+0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options\r
+1) Added an Exception Vector Table browser window\r
+2) Modified the About window to update the credits list in a more appropriate way\r
+-- Updated the emulator application credits line\r
+3) Added 'Rx' word to the emulator name\r
+4) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used\r
+5) Added ui, alpine & debugger groups in the settings\r
+6) Added the possibility to erase settings\r
+7) Added the --es-all, --es-ui, --es-alpine & --es-debugger options to erase specific settings\r
+8) Added a keybindings tab and adapted the configuration dialog tabs\r
+-- User can modify the keybindings where appropriate\r
+-- Keybindings UI is displayed based on the option used (--debugger, -- alpine)\r
+9) Fixed a crash, in Release mode, when the HW labels setting is turn on\r
+10) Solved an interference between the HW labels setting and the one used by the debugger\r
+-- The setting is now only the reference used\r
+11) Fixed the SP (Stack) window UI potential missing data\r
+12) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist\r
+13) Keep the scrollbar position in accordance of the M68K PC pointer\r
+-- UI displays the source without the need to move down/up the scrollbar\r
+14) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file\r
+-- This may come from the linker vlink\r
+15) Improved the .heap section detection to avoid a detection error\r
+-- Depend vlink version, .heap section may have an Alloc flag\r
+16) Fixed a crash when DWARF information does references to missing source code files\r
+17) Added a Local browser window for local variables\r
+\r
+Release 2 (3rd September 2017)\r
+------------------------------\r
+0) Added some error detections when reading the ELF executable file\r
+1) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)\r
+2) "Step Over" code function for BSR/JSR functions\r
+3) Added the .debug_ranges detection to avoid a detection error\r
+4) DWARF support\r
+-- TAG: Compilation Unit, Subprogram, Variables, Types\r
+-- Line numbers, symbols, functions\r
+5) Added an All Watch browser window for non-local variables\r
+6) Added a heap allocator browser window based on my own memory allocation functions\r
+7) Added additional 4 memory browser windows with address input based on hexa, decimal or symbol name\r
+8) Windows refreshing executed only if windows is visible\r
+9) Added a restart function\r
+-- Restart only the 68000 program counter to his original set\r
+10) Modified the icons color backgound for the "Step In" and "Step Over" functions\r
+11) Updated the About window to update the credits list\r
+12) 64 bits Release executable\r
+13) Fixed (hacking) the display of the SP (Stack) memory browser\r
+14) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom\r
+-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address\r
+15) Added some information in the --help/-h/-? option\r
+16) --debugger option no longer force the log file\r
+17) Added a --dram-max option to extend the DRAM size to 8MB\r
+18) Added the "enter" key support when setting the BPM (Breapoint)\r
+19) Save the windows positions, size and visibilities (show or hide) status\r
+-- Such windows will automatically respawn in the next emulator launch\r
+\r
+Release 1 (12th February 2017)\r
+------------------------------\r
+0) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code\r
+1) Clean-up the tracing / no-tracing flags for better U.I understanding\r
+2) Added SP (Stack) memory browser\r
+3) User can change now the number of lines of disassembly displayed in the tracing window\r
+4) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window\r
+5) Added an emulator status window (GPU status, M68K debugger & tracking status)\r
+6) Added a GPU disassembly tracing window - Display the current PC pointer\r
+7) Added a DSP disassembly tracing window - Display the current PC pointer\r
+8) Added possibility to change refresh rate of browser windows when emulation is launched\r
+9) Display partial hardware labels (Internal Memory & Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window\r
+-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol\r
+10) Minor U.I cosmetic changes\r
+11) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window\r
+-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol\r
+\r
+Release 0 (5th January 2017)\r
+----------------------------\r
+0) New option --debugger\r
+1) ELF format support\r
+2) ELF debug symbol support\r
+3) "Step Into" code function\r
+4) Menus layout dedicated to the debugger\r
+5) Added a dedicated main window for tracing (M68K)\r
+6) Added a Debugger tab in the config tab\r
+7) Visual Studio 2015 project support\r
+8) libelf-0.8.13 library support\r
+9) 64 bits debug executable only\r
+\r
+\r
+Known issues\r
+============\r
+1) Video output is not displayed due to my OpenGL / QT5 integration with VS 2015\r
+2) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution\r
+-- Need to trace over the BPM or unset the BPM\r
+3) To handle DWARF 2 issues with GCC, the code must be compiled with the -gdwarf-2 option\r
+4) The Local & Watch variables list may display not available (N/A) type information\r
+-- Such missing information may be included in future release\r
+5) The 2MB mirroring is no longer applied in case of --dram-max option usage\r
+6) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted\r
+-- The application needs to set the SP (Stack) in accordance\r
+7) The Exception Vector Table broswer window displays only 65 vectors\r
+-- Missing vectors may be added in future release\r
+8) User needs to manualy check if the Atari Jaguar executable match his source code files\r
+-- Otherwise, source code and assembly may not match or leads to instabilities\r
+9) Application needs to be restarted in case of keybindings changes\r
+\r
+Cosmetic / UX issues\r
+====================\r
+1) The SP (Stack) icon color backgound doesn't look similar with the other ones\r
+2) The emulator status option has no icon\r
+3) The SP (Stack) window size always open at a forced size no matter if the size has been changed\r
+4) Not every features have associated keybindings\r
+\r
+Legacy issues/hints\r
+===================\r
+1) Emulator seems to have easter egg(s)\r
+-- The option --yarrr displays a single message and end the application\r
+-- Pressing F8, while in the main window, will create an extra message in the log file\r
+2) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option\r
+\r
+Project information\r
+===================\r
+1) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)\r
+2) Visual Studio 2015 project support for 64 bits\r
+3) libelf 0.8.13 library 64bits for VS 2015\r
+4) libdwarf 1.41 library 64bits for VS 2015, cygwin64 & Msys2/MinGW64\r
+5) QT 5.5.1 library 64bits for VS 2015\r
+6) Zlib 1.2.8 library 64bits for VS 2015\r
+7) SDL 1.2.15 library 64bits for VS 2015\r
+8) The original make files have been modified to follow the requirements and modifications\r
+9) The 'Rx' word has been added to the emulator name to make distinction with the official version\r
+10) The project source is set at https://github.com/djipi/Virtual-Jaguar-Rx\r
+11) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements\r
+-- Text / License terms are the same\r
+\r
+\r
+Download statistics\r
+-------------------\r
+jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017\r
+jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017\r
+No downloads statistics available for the Release 2
\ No newline at end of file