Prevent source file reading issue on no-Windows system
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_ReleaseNotes.txt
CommitLineData
879b84c5
JPM
1Release 4 (TBD)\r
2---------------\r
30) The zoom value setting has been fixed in the registry\r
e857856a 41) Debugger mode now shares the same alpine rom path setting\r
1bb61ebf 52) Local variables window displays register name now\r
a2dfb8e5 63) Switch to Zlib 1.2.11 static library 64bits for VS 2017\r
169c1409 74) Switch to SDL 1.2.15 static library 64bits for VS 2017\r
1bb61ebf
JPM
85) Local variables window displays values from function's parameters\r
96) Fixed the typedef's name display in Local and Watch variables window\r
a8c13b4d
JPM
107) Breakpoint may now occur in case of a ROM cartridge writing\r
11-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check\r
eb20f274 12-- 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
47b6ecae 138) Local variables window detects now if a variable is used or not by the code\r
8d867eb2 149) The address provided in the memory window is now verified to prevent crash\r
a2dfb8e5
JPM
15-- Wrong address will be displayed in red\r
1610) Cosmetic changes on UI\r
17-- Added new icons for the exit and status features\r
18-- Modified icons for the SP (Stack) browser\r
19-- Unified icons sizes depend on their usage (drop down menu and main menu)\r
20-- Underline the active M68K line in the disassembly window\r
21-- Allow the up/down navigation on the SP (Stack) browser\r
22-- Restart function cleans-up the SP (Stack) browser and the heap allocator system\r
2311) Fixed the up navigation on the memory window\r
a8c13b4d
JPM
2412) Added some log information for the emulator initialisations\r
2513) Breakpoint will happen in case of writing at unknown memory location\r
26-- Alert box will display a message and then code will stop\r
879b84c5 27\r
b1b673a3
JPM
28Release 3 (13th November 2017)\r
29------------------------------\r
a2dfb8e5
JPM
30Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7\r
31-\r
2d0121d4 320) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options\r
8d867eb2 331) Added an Exception Vector Table window\r
be44e757
JPM
342) Modified the About window to update the credits list in a more appropriate way\r
35-- Updated the emulator application credits line\r
363) Added 'Rx' word to the emulator name\r
374) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used\r
1bb61ebf 385) Added ui, alpine and debugger groups in the settings\r
be44e757 396) Added the possibility to erase settings\r
1bb61ebf 407) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings\r
024bfc46
JPM
418) Added a keybindings tab and adapted the configuration dialog tabs\r
42-- User can modify the keybindings where appropriate\r
0d612b97 43-- Keybindings UI is displayed based on the option used (--debugger, -- alpine)\r
2d0121d4
JPM
449) Fixed a crash, in Release mode, when the HW labels setting is turn on\r
4510) Solved an interference between the HW labels setting and the one used by the debugger\r
46-- The setting is now only the reference used\r
a2dfb8e5 4711) Fixed the SP (Stack) browser UI potential missing data\r
4bb7c3f5 4812) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist\r
9bf5c434 4913) Keep the scrollbar position in accordance of the M68K PC pointer\r
41d6f5f7 50-- UI displays the source without the need to move down/up the scrollbar\r
95fe01d7 5114) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file\r
41d6f5f7 52-- This may come from the linker vlink\r
88b2434e
JPM
5315) Improved the .heap section detection to avoid a detection error\r
54-- Depend vlink version, .heap section may have an Alloc flag\r
95fe01d7 5516) Fixed a crash when DWARF information does references to missing source code files\r
8d867eb2 5617) Added a local variables window\r
820579e2 5718) Project has switched to Visual Studio 2017 and QT 5.9.1 library\r
be44e757
JPM
58\r
59Release 2 (3rd September 2017)\r
60------------------------------\r
610) Added some error detections when reading the ELF executable file\r
621) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)\r
632) "Step Over" code function for BSR/JSR functions\r
643) Added the .debug_ranges detection to avoid a detection error\r
654) DWARF support\r
66-- TAG: Compilation Unit, Subprogram, Variables, Types\r
67-- Line numbers, symbols, functions\r
8d867eb2
JPM
685) Added an All Watch window for non-local variables\r
696) Added a heap allocator window based on my own memory allocation functions\r
707) Added additional 4 memory windows with address input based on hexa, decimal or symbol name\r
be44e757
JPM
718) Windows refreshing executed only if windows is visible\r
729) Added a restart function\r
73-- Restart only the 68000 program counter to his original set\r
7410) Modified the icons color backgound for the "Step In" and "Step Over" functions\r
7511) Updated the About window to update the credits list\r
7612) 64 bits Release executable\r
a2dfb8e5 7713) Fixed (hacking) the display of the SP (Stack) browser\r
be44e757
JPM
7814) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom\r
79-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address\r
8015) Added some information in the --help/-h/-? option\r
8116) --debugger option no longer force the log file\r
8217) Added a --dram-max option to extend the DRAM size to 8MB\r
8318) Added the "enter" key support when setting the BPM (Breapoint)\r
8419) Save the windows positions, size and visibilities (show or hide) status\r
85-- Such windows will automatically respawn in the next emulator launch\r
86\r
87Release 1 (12th February 2017)\r
88------------------------------\r
890) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code\r
901) Clean-up the tracing / no-tracing flags for better U.I understanding\r
a2dfb8e5 912) Added SP (Stack) browser\r
be44e757
JPM
923) User can change now the number of lines of disassembly displayed in the tracing window\r
934) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window\r
1bb61ebf 945) Added an emulator status window (GPU status, M68K debugger and tracking status)\r
be44e757
JPM
956) Added a GPU disassembly tracing window - Display the current PC pointer\r
967) Added a DSP disassembly tracing window - Display the current PC pointer\r
a2dfb8e5 978) Added possibility to change refresh rate of browsers when emulation is launched\r
1bb61ebf 989) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window\r
be44e757
JPM
99-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol\r
10010) Minor U.I cosmetic changes\r
10111) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window\r
102-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol\r
103\r
104Release 0 (5th January 2017)\r
105----------------------------\r
1060) New option --debugger\r
1071) ELF format support\r
1082) ELF debug symbol support\r
1093) "Step Into" code function\r
1104) Menus layout dedicated to the debugger\r
1115) Added a dedicated main window for tracing (M68K)\r
1126) Added a Debugger tab in the config tab\r
1137) Visual Studio 2015 project support\r
1148) libelf-0.8.13 library support\r
1159) 64 bits debug executable only\r
116\r
117\r
118Known issues\r
119============\r
820579e2 1201) 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
be44e757
JPM
1212) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution\r
122-- Need to trace over the BPM or unset the BPM\r
eb20f274
JPM
123-- 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
1243) To support DWARF 2 with GCC, the code must be compiled with the -gdwarf-2 option\r
a2dfb8e5 1254) The Local and Watch variables window may display not available (N/A) type information\r
be44e757
JPM
126-- Such missing information may be included in future release\r
1275) The 2MB mirroring is no longer applied in case of --dram-max option usage\r
1286) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted\r
129-- The application needs to set the SP (Stack) in accordance\r
a2dfb8e5 1307) The Exception Vector Table window displays only 65 vectors\r
be44e757 131-- Missing vectors may be added in future release\r
49a6ac1c
JPM
1328) User needs to manualy check if the Atari Jaguar executable match his source code files\r
133-- Otherwise, source code and assembly may not match or leads to instabilities\r
eb20f274 1349) The emulator needs to be restarted in case of keybindings changes\r
a2dfb8e5
JPM
13510) 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
13611) Emulator will crash in case of wrong address value provided in the memory browser\r
a8c13b4d 13712) The RAM access log is limited to the 2MB\r
be44e757
JPM
138\r
139Cosmetic / UX issues\r
140====================\r
1411) The SP (Stack) icon color backgound doesn't look similar with the other ones\r
a2dfb8e5
JPM
1422) The SP (Stack) browser size always open at a forced size no matter if the size has been changed\r
1433) Not every features have associated keybindings\r
be44e757
JPM
144\r
145Legacy issues/hints\r
146===================\r
1471) Emulator seems to have easter egg(s)\r
148-- The option --yarrr displays a single message and end the application\r
2d0121d4 149-- Pressing F8, while in the main window, will create an extra message in the log file\r
be44e757
JPM
1502) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option\r
151\r
152Project information\r
153===================\r
024bfc46 1541) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)\r
820579e2
JPM
1552) Visual Studio 2015/2017 project support for 64 bits\r
1563) libelf 0.8.13 library 64bits for VS 2015/2017\r
1bb61ebf 1574) libdwarf 1.41 library 64bits for VS 2015, cygwin64 and Msys2/MinGW64\r
be44e757 1585) QT 5.5.1 library 64bits for VS 2015\r
820579e2 1596) QT 5.9.1 library 64bits for VS 2017\r
e857856a
JPM
1607) Zlib 1.2.8 library 64bits for VS 2015\r
1617) Zlib 1.2.11 library 64bits for VS 2017\r
169c1409 1628) SDL 1.2.15 library 64bits for VS 2015/2017\r
820579e2
JPM
1639) The original make files have been modified to follow the requirements and modifications\r
16410) The 'Rx' word has been added to the emulator name to make distinction with the official version\r
16511) The project source is set at https://github.com/djipi/Virtual-Jaguar-Rx\r
16612) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements\r
be44e757
JPM
167-- Text / License terms are the same\r
168\r
169\r
170Download statistics\r
171-------------------\r
172jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017\r
173jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017\r
e857856a
JPM
174No downloads statistics available for the Release 2\r
175No downloads statistics available for the Release 3\r