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