UI modifications
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_ReleaseNotes.txt
index 41643b4..5ad331e 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
@@ -13,28 +15,43 @@ Release 4 (TBD)
 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
+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
-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
+-- 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
-19) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information\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), 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
 \r
 Release 3 (13th November 2017)\r
 ------------------------------\r
@@ -133,8 +150,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
@@ -142,7 +160,9 @@ 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
+-- Keybindings 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