Minor cosmetic and comments modifications
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_ReleaseNotes.txt
index db03424..6fa36f0 100644 (file)
@@ -1,5 +1,7 @@
 Release 4 (TBD)\r
 ---------------\r
+Git commit: TBD\r
+-\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
@@ -11,19 +13,57 @@ Release 4 (TBD)
 -- 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
+9) The address provided in the debugger memory windows is now verified to prevent crash\r
 -- Wrong address will be displayed in red\r
-10) Cosmetic changes on UI\r
+10) UI 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
+-- Fixed the up navigation on the memory window\r
+11) Added some log information for the emulator initialisations\r
+12) Breakpoint will happen in case of writing at unknown memory location\r
+-- Alert box will display a message and then the code will stop\r
+13) Added the DRAM size in the emulator status window\r
+14) Debugger sources code clean-up\r
+15) Added a call stack feature\r
+16) Follow platform requirement to prevent source file reading issue\r
+17) 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
+18) 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
+19) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement\r
+20) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)\r
+21) Added a Jaguar model and BIOS configuration tab\r
+22) Jaguar model and BIOS configuration integration\r
+23) Added LEB128 decoding functions\r
+-- It is used for the DWARF decoding information\r
+24) Debugger support improvement\r
+-- DWARF support for the enum type (partial), structure and subroutine type\r
+-- Debugger can report variable's unsigned char value\r
+25) UI modifications\r
+-- Added a status bar, better status report & information display for the heap allocation window\r
+-- Added a status bar, better status report & information display for the local variables window\r
+-- Added better information display for the exception vectors table window, and added some missing vectors\r
+-- Added a status bar, better status report & information display for the call stack window\r
+-- Added a status bar, better status report & information display for the all watches window\r
+26) Added screenshot feature\r
+-- Not accessible in debugger mode\r
+-- Added screenshot editable path in the general tab, and a key binding\r
+27) Minor misspellings fixes\r
+28) DWARF source code directory path clean-up\r
+29) Added a source code files list viewer\r
+-- List comes from the DWARF information\r
+30) Check potential variables missing/incomplete description found in the DWARF information\r
+-- No crash involved but can help to reduce such as variables duplicate or the blank ones\r
+31) Added a sorting filter in the all watches window\r
+32) Improve source code file reading to avoid additional text/bytes reading\r
+33) Help & content texts updates\r
 \r
 Release 3 (13th November 2017)\r
 ------------------------------\r
@@ -38,9 +78,9 @@ Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
 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 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
+8) Added a key bindings tab and adapted the configuration dialog tabs\r
+-- User can modify the key bindings where appropriate\r
+-- Key bindings 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
@@ -122,8 +162,9 @@ Known issues
 -- Need to trace over the BPM or unset the BPM\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
+4) The Local and Watch variables window  may display not available type information or empty information\r
 -- Such missing information may be included in future release\r
+-- The 'const' type may not be reported correctly in the DWARF information \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
@@ -131,16 +172,20 @@ Known issues
 -- 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
+9) The emulator needs to be restarted in case of the following actions occur\r
+-- Key bindings changes\r
+-- BIOS selection changes and without new executable load\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
+13) In various occasions, global variables may be duplicated or without name in the DWARF information\r
+-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option\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 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
+3) Not every features have associated key bindings\r
 \r
 Legacy issues/hints\r
 ===================\r
@@ -158,12 +203,12 @@ Project information
 5) QT 5.5.1 library 64bits for VS 2015\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
+8) Zlib 1.2.11 library 64bits for VS 2017\r
+9) SDL 1.2.15 library 64bits for VS 2015/2017\r
+10) The original make files have been modified to follow the requirements and modifications\r
+11) The 'Rx' word has been added to the emulator name to make distinction with the official version\r
+12) The project is set at https://github.com/djipi/Virtual-Jaguar-Rx\r
+13) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements\r
 -- Text / License terms are the same\r
 \r
 \r