Local browser window displays register name used for local variables
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_ReleaseNotes.txt
1 Release 4 (TBD)
2 ---------------
3 0) The zoom value setting has been fixed in the registry
4 1) Debugger mode now shares the same alpine rom path setting
5 2) Local browser window displays register name used for local variables
6 3) Switch to Zlib 1.2.11 library 64bits for VS 2017
7
8 Release 3 (13th November 2017)
9 ------------------------------
10 0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
11 1) Added an Exception Vector Table browser window
12 2) Modified the About window to update the credits list in a more appropriate way
13 -- Updated the emulator application credits line
14 3) Added 'Rx' word to the emulator name
15 4) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
16 5) Added ui, alpine & debugger groups in the settings
17 6) Added the possibility to erase settings
18 7) Added the --es-all, --es-ui, --es-alpine & --es-debugger options to erase specific settings
19 8) Added a keybindings tab and adapted the configuration dialog tabs
20 -- User can modify the keybindings where appropriate
21 -- Keybindings UI is displayed based on the option used (--debugger, -- alpine)
22 9) Fixed a crash, in Release mode, when the HW labels setting is turn on
23 10) Solved an interference between the HW labels setting and the one used by the debugger
24 -- The setting is now only the reference used
25 11) Fixed the SP (Stack) window UI potential missing data
26 12) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
27 13) Keep the scrollbar position in accordance of the M68K PC pointer
28 -- UI displays the source without the need to move down/up the scrollbar
29 14) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
30 -- This may come from the linker vlink
31 15) Improved the .heap section detection to avoid a detection error
32 -- Depend vlink version, .heap section may have an Alloc flag
33 16) Fixed a crash when DWARF information does references to missing source code files
34 17) Added a Local browser window for local variables
35 18) Project has switched to Visual Studio 2017 and QT 5.9.1 library
36
37 Release 2 (3rd September 2017)
38 ------------------------------
39 0) Added some error detections when reading the ELF executable file
40 1) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
41 2) "Step Over" code function for BSR/JSR functions
42 3) Added the .debug_ranges detection to avoid a detection error
43 4) DWARF support
44 -- TAG: Compilation Unit, Subprogram, Variables, Types
45 -- Line numbers, symbols, functions
46 5) Added an All Watch browser window for non-local variables
47 6) Added a heap allocator browser window based on my own memory allocation functions
48 7) Added additional 4 memory browser windows with address input based on hexa, decimal or symbol name
49 8) Windows refreshing executed only if windows is visible
50 9) Added a restart function
51 -- Restart only the 68000 program counter to his original set
52 10) Modified the icons color backgound for the "Step In" and "Step Over" functions
53 11) Updated the About window to update the credits list
54 12) 64 bits Release executable
55 13) Fixed (hacking) the display of the SP (Stack) memory browser
56 14) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
57 -- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
58 15) Added some information in the --help/-h/-? option
59 16) --debugger option no longer force the log file
60 17) Added a --dram-max option to extend the DRAM size to 8MB
61 18) Added the "enter" key support when setting the BPM (Breapoint)
62 19) Save the windows positions, size and visibilities (show or hide) status
63 -- Such windows will automatically respawn in the next emulator launch
64
65 Release 1 (12th February 2017)
66 ------------------------------
67 0) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
68 1) Clean-up the tracing / no-tracing flags for better U.I understanding
69 2) Added SP (Stack) memory browser
70 3) User can change now the number of lines of disassembly displayed in the tracing window
71 4) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
72 5) Added an emulator status window (GPU status, M68K debugger & tracking status)
73 6) Added a GPU disassembly tracing window - Display the current PC pointer
74 7) Added a DSP disassembly tracing window - Display the current PC pointer
75 8) Added possibility to change refresh rate of browser windows when emulation is launched
76 9) Display partial hardware labels (Internal Memory & Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
77 -- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
78 10) Minor U.I cosmetic changes
79 11) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
80 -- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
81
82 Release 0 (5th January 2017)
83 ----------------------------
84 0) New option --debugger
85 1) ELF format support
86 2) ELF debug symbol support
87 3) "Step Into" code function
88 4) Menus layout dedicated to the debugger
89 5) Added a dedicated main window for tracing (M68K)
90 6) Added a Debugger tab in the config tab
91 7) Visual Studio 2015 project support
92 8) libelf-0.8.13 library support
93 9) 64 bits debug executable only
94
95
96 Known issues
97 ============
98 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
99 2) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
100 -- Need to trace over the BPM or unset the BPM
101 3) To handle DWARF 2 issues with GCC, the code must be compiled with the -gdwarf-2 option
102 4) The Local & Watch variables list may display not available (N/A) type information
103 -- Such missing information may be included in future release
104 5) The 2MB mirroring is no longer applied in case of --dram-max option usage
105 6) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
106 -- The application needs to set the SP (Stack) in accordance
107 7) The Exception Vector Table broswer window displays only 65 vectors
108 -- Missing vectors may be added in future release
109 8) User needs to manualy check if the Atari Jaguar executable match his source code files
110 -- Otherwise, source code and assembly may not match or leads to instabilities
111 9) Application needs to be restarted in case of keybindings changes
112
113 Cosmetic / UX issues
114 ====================
115 1) The SP (Stack) icon color backgound doesn't look similar with the other ones
116 2) The emulator status option has no icon
117 3) The SP (Stack) window size always open at a forced size no matter if the size has been changed
118 4) Not every features have associated keybindings
119
120 Legacy issues/hints
121 ===================
122 1) Emulator seems to have easter egg(s)
123 -- The option --yarrr displays a single message and end the application
124 -- Pressing F8, while in the main window, will create an extra message in the log file
125 2) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
126
127 Project information
128 ===================
129 1) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
130 2) Visual Studio 2015/2017 project support for 64 bits
131 3) libelf 0.8.13 library 64bits for VS 2015/2017
132 4) libdwarf 1.41 library 64bits for VS 2015, cygwin64 & Msys2/MinGW64
133 5) QT 5.5.1 library 64bits for VS 2015
134 6) QT 5.9.1 library 64bits for VS 2017
135 7) Zlib 1.2.8 library 64bits for VS 2015
136 7) Zlib 1.2.11 library 64bits for VS 2017
137 8) SDL 1.2.15 library 64bits for VS 2015
138 9) The original make files have been modified to follow the requirements and modifications
139 10) The 'Rx' word has been added to the emulator name to make distinction with the official version
140 11) The project source is set at https://github.com/djipi/Virtual-Jaguar-Rx
141 12) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
142 -- Text / License terms are the same
143
144
145 Download statistics
146 -------------------
147 jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
148 jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
149 No downloads statistics available for the Release 2
150 No downloads statistics available for the Release 3