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