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