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