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