UI modifications and crash fix
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_ReleaseNotes.txt
index 36d75d5..41643b4 100644 (file)
@@ -1,14 +1,71 @@
-Release 3 (TBC)\r
+Release 4 (TBD)\r
 ---------------\r
-0) Fixed the windows respawning in the next emulator launch without --alpine or --debugger options\r
-1) Added an Exception Vector Table browser window\r
+0) The zoom value setting has been fixed in the registry\r
+1) Debugger mode now shares the same alpine rom path setting\r
+2) Local variables window displays register name now\r
+3) Switch to Zlib 1.2.11 static library 64bits for VS 2017\r
+4) Switch to SDL 1.2.15 static library 64bits for VS 2017\r
+5) Local variables window displays values from function's parameters\r
+6) Fixed the typedef's name display in Local and Watch variables window\r
+7) Breakpoint may now occur in case of a ROM cartridge writing\r
+-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check\r
+-- Alert box will display a message with possibility to pass or not the breakpoint only if this is related to a 8 or 16 bits ROM access\r
+8) Local variables window detects now if a variable is used or not by the code\r
+9) The address provided in the memory window is now verified to prevent crash\r
+-- Wrong address will be displayed in red\r
+10) UI cosmetic changes \r
+-- Added new icons for the exit and status features\r
+-- Modified icons for the SP (Stack) browser\r
+-- Unified icons sizes depend on their usage (drop down menu and main menu)\r
+-- Underline the active M68K line in the disassembly window\r
+-- Allow the up/down navigation on the SP (Stack) browser\r
+-- Restart function cleans-up the SP (Stack) browser and the heap allocator system\r
+11) Fixed the up navigation on the memory window\r
+12) Added some log information for the emulator initialisations\r
+13) Breakpoint will happen in case of writing at unknown memory location\r
+-- Alert box will display a message and then code will stop\r
+14) Added the DRAM size in the emulator status window\r
+15) Debugger sources code clean-up\r
+16) Added a call stack feature\r
+17) Prevent source file reading issue on no-Windows system \r
+18) UI modifications\r
+-- Modified icon for the memory window to make a distinction with the memory browser\r
+-- The all watch, and Exception Vector Table windows, can be closed using keyboard\r
+-- Renamed the debugger dedicated icons to make a distinction\r
+-- Added the call stack window\r
+19) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information\r
+-- Previously used ELF/DWARF information was still accessible\r
+\r
+Release 3 (13th November 2017)\r
+------------------------------\r
+Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7\r
+-\r
+0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options\r
+1) Added an Exception Vector Table 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
+5) Added ui, alpine and 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
+7) Added the --es-all, --es-ui, --es-alpine and --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) browser 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 variables window\r
+18) Project has switched to Visual Studio 2017 and QT 5.9.1 library\r
 \r
 Release 2 (3rd September 2017)\r
 ------------------------------\r
@@ -19,16 +76,16 @@ Release 2 (3rd September 2017)
 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
+5) Added an All Watch window for non-local variables\r
+6) Added a heap allocator window based on my own memory allocation functions\r
+7) Added additional 4 memory 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
+13) Fixed (hacking) the display of the SP (Stack) 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
@@ -42,14 +99,14 @@ Release 1 (12th February 2017)
 ------------------------------\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
+2) Added SP (Stack) 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
+5) Added an emulator status window (GPU status, M68K debugger and 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
+8) Added possibility to change refresh rate of browsers when emulation is launched\r
+9) Display partial hardware labels (Internal Memory and 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
@@ -71,43 +128,53 @@ Release 0 (5th January 2017)
 \r
 Known issues\r
 ============\r
-1) Video output is not displayed due to OpenGL / QT5 integration problems with VS 2015\r
+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\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 Watch variables list may display not available (N/A) type information\r
+-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control\r
+3) To support DWARF 2 with GCC, the code must be compiled with the -gdwarf-2 option\r
+4) The Local and Watch variables window  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
+7) The Exception Vector Table 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) The emulator needs to be restarted in case of keybindings changes\r
+10) In the case of a ROM cartridge writing, and with occuring breakpoint, the PC pointer will point at the next instruction and not at the instruction causing the breakpoint\r
+11) Emulator will crash in case of wrong address value provided in the memory browser\r
+12) The RAM access log is limited to the 2MB\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
+2) The SP (Stack) browser size always open at a forced size no matter if the size has been changed\r
+3) 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 13th June 2016\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
+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/2017 project support for 64 bits\r
+3) libelf 0.8.13 library 64bits for VS 2015/2017\r
+4) libdwarf 1.41 library 64bits for VS 2015, cygwin64 and 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
+6) QT 5.9.1 library 64bits for VS 2017\r
+7) Zlib 1.2.8 library 64bits for VS 2015\r
+7) Zlib 1.2.11 library 64bits for VS 2017\r
+8) SDL 1.2.15 library 64bits for VS 2015/2017\r
+9) The original make files have been modified to follow the requirements and modifications\r
+10) The 'Rx' word has been added to the emulator name to make distinction with the official version\r
+11) The project source is set at https://github.com/djipi/Virtual-Jaguar-Rx\r
+12) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements\r
 -- Text / License terms are the same\r
 \r
 \r
@@ -115,4 +182,5 @@ Download statistics
 -------------------\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 available for the Release 2
\ No newline at end of file
+No downloads statistics available for the Release 2\r
+No downloads statistics available for the Release 3\r