Added search paths in case of missing DWARF directories information
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_ReleaseNotes.txt
index 5ad331e..ccb55e6 100644 (file)
@@ -13,7 +13,7 @@ Git commit: 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) UI changes \r
 -- Added new icons for the exit and status features\r
@@ -44,7 +44,7 @@ Git commit: TBD
 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), and subroutine type\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
@@ -52,6 +52,24 @@ Git commit: TBD
 -- 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
+34) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom\r
+35) Added the support for the used lines source's DWARF structure\r
+-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC\r
+36) Added the Rx version's contact in the help text\r
+37) Added search paths in case of missing DWARF directories information\r
+-- Used to look for the file(s)\r
 \r
 Release 3 (13th November 2017)\r
 ------------------------------\r
@@ -66,9 +84,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
@@ -149,7 +167,8 @@ Known issues
 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
 -- 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
+3) To support DWARF 2\r
+-- With GCC: the code must be compiled with the -gdwarf-2 option\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
@@ -161,17 +180,19 @@ Known issues
 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 the following actions occur\r
--- Keybindings changes\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
@@ -189,12 +210,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