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