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