Merge branch 'develop' of into develop
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_HistoryNotes.txt
1Release 5 (TBA)
30) Added a date creation stamp in the application command line information
4- This date already appears in the Release 4 executable but was not referenced in his history note
51) Added a specific breakpoint for the M68K illegal instruction exception
6-- Alert box will display a message and then the code will stop
8Release 4a (15th August 2019)
10Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
120) Fix specific breakpoint for ROM cartridge or unknown memory location writing
14Release 4 (10th August 2019)
16Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
180) The zoom value setting has been fixed in the registry
191) Debugger mode now shares the same alpine rom path setting
202) Local variables window displays register name now
213) Switch to Zlib 1.2.11 static library 64bits for VS 2017
224) Switch to SDL 1.2.15 static library 64bits for VS 2017
235) Local variables window displays values from function's parameters
246) Fixed the typedef's name display in Local and Watch variables window
257) Breakpoint may now occur in case of a ROM cartridge writing
26-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
27-- Alert box will display a message with possibility to pass or not the breakpoint only if this is related to a 8 or 16 bits ROM access
288) Local variables window detects now if a variable is used or not by the code
299) The address provided in the debugger memory windows is now verified to prevent crash
30-- Wrong address will be displayed in red
3110) UI changes
32-- Added new icons for the exit and status features
33-- Modified icons for the SP (Stack) browser
34-- Unified icons sizes depend on their usage (drop down menu and main menu)
35-- Underline the active M68K line in the disassembly window
36-- Allow the up/down navigation on the SP (Stack) browser
37-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
38-- Fixed the up navigation on the memory window
3911) Added some log information for the emulator initialisations
4012) Breakpoint will happen in case of writing at unknown memory location
41-- Alert box will display a message and then the code will stop
4213) Added the DRAM size in the emulator status window
4314) Debugger sources code clean-up
4415) Added a call stack feature
4516) Follow platform requirement to prevent source file reading issue
4617) UI modifications
47-- Modified icon for the memory window to make a distinction with the memory browser
48-- The all watch, and Exception Vector Table windows, can be closed using keyboard
49-- Renamed the debugger dedicated icons to make a distinction
50-- Added the call stack window
5118) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
52-- Previously used ELF/DWARF information was still accessible
5319) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
5420) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
5521) Added a Jaguar model and BIOS configuration tab
5622) Jaguar model and BIOS configuration integration
5723) Added LEB128 decoding functions
58-- It is used for the DWARF decoding information
5924) Debugger support improvement
60-- DWARF support for the enum type (partial), structure and subroutine type
61-- Debugger can report variable's unsigned char value
6225) UI modifications
63-- Added a status bar, better status report & information display for the heap allocation window
64-- Added a status bar, better status report & information display for the local variables window
65-- Added better information display for the exception vectors table window, and added some missing vectors
66-- Added a status bar, better status report & information display for the call stack window
67-- Added a status bar, better status report & information display for the all watches window
6826) Added screenshot feature
69-- Not accessible in debugger mode
70-- Added screenshot editable path in the general tab, and a key binding
7127) Minor misspellings fixes
7228) DWARF source code directory path clean-up
7329) Added a source code files list viewer
74-- List comes from the DWARF information
7530) Check potential variables missing/incomplete description found in the DWARF information
76-- No crash involved but can help to reduce such as variables duplicate or the blank ones
7731) Added a sorting filter in the all watches window
7832) Improve source code file reading to avoid additional text/bytes reading
7933) Help & content texts updates
8034) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
8135) Added the support for the used lines source's DWARF structure
82-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
8336) Added the Rx version's contact in the help text
8437) Added search paths in case of missing DWARF directories information
85-- Used to look for the file(s)
8638) Setup CU's low/high PC in case of the DWARF structures doesn't have it
87-- Used mostly to allow display the source assembled with vasm
8839) Added function name support from ELF structure
8940) Added the return address information in the call stack
8d705db0 9041) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 9142) Added timer initialisation for the SDL setup
f99a6ebc 9243) Added a cartridge view menu
24470541 93-- Added a window to display my own directory and his files list
6642f781 9444) Debugger sources code clean-up
acd3342f 9545) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 9646) Fix crash with potential missing DWARF structure tag's type name
9747) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
9848) Project has switched to QT 5.12.0 library 64bits for VS 2017
3323d78b 9949) Added a Save Dump As... feature to save a memory zone to a file
10050) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
101-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 10251) Removed the sorting filter in the all watches window
96bd5390 10352) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 10453) Set cartridge view menu for debugger mode only
8b11a1b0 10554) Prevent crash in case of call stack is out of range
107Release 3 (13th November 2017)
109Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
1110) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1121) Added an Exception Vector Table window
1132) Modified the About window to update the credits list in a more appropriate way
114-- Updated the emulator application credits line
1153) Added 'Rx' word to the emulator name
1164) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1175) Added ui, alpine and debugger groups in the settings
1186) Added the possibility to erase settings
1197) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1208) Added a key bindings tab and adapted the configuration dialog tabs
121-- User can modify the key bindings where appropriate
122-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1239) Fixed a crash, in Release mode, when the HW labels setting is turn on
12410) Solved an interference between the HW labels setting and the one used by the debugger
125-- The setting is now only the reference used
12611) Fixed the SP (Stack) browser UI potential missing data
12712) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
12813) Keep the scrollbar position in accordance of the M68K PC pointer
129-- UI displays the source without the need to move down/up the scrollbar
13014) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
131-- This may come from the linker vlink
13215) Improved the .heap section detection to avoid a detection error
133-- Depend vlink version, .heap section may have an Alloc flag
13416) Fixed a crash when DWARF information does references to missing source code files
13517) Added a local variables window
13618) Project has switched to Visual Studio 2017 and QT 5.9.1 library
138Release 2 (3rd September 2017)
1400) Added some error detections when reading the ELF executable file
1411) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1422) "Step Over" code function for BSR/JSR functions
1433) Added the .debug_ranges detection to avoid a detection error
1444) DWARF support
145-- TAG: Compilation Unit, Subprogram, Variables, Types
146-- Line numbers, symbols, functions
1475) Added an All Watch window for non-local variables
1486) Added a heap allocator window based on my own memory allocation functions
1497) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1508) Windows refreshing executed only if windows is visible
1519) Added a restart function
152-- Restart only the 68000 program counter to his original set
15310) Modified the icons color backgound for the "Step In" and "Step Over" functions
15411) Updated the About window to update the credits list
15512) 64 bits Release executable
15613) Fixed (hacking) the display of the SP (Stack) browser
15714) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
158-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
15915) Added some information in the --help/-h/-? option
16016) --debugger option no longer force the log file
16117) Added a --dram-max option to extend the DRAM size to 8MB
16218) Added the "enter" key support when setting the BPM (Breapoint)
16319) Save the windows positions, size and visibilities (show or hide) status
164-- Such windows will automatically respawn in the next emulator launch
166Release 1 (12th February 2017)
1680) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1691) Clean-up the tracing / no-tracing flags for better U.I understanding
1702) Added SP (Stack) browser
1713) User can change now the number of lines of disassembly displayed in the tracing window
1724) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
1735) Added an emulator status window (GPU status, M68K debugger and tracking status)
1746) Added a GPU disassembly tracing window - Display the current PC pointer
1757) Added a DSP disassembly tracing window - Display the current PC pointer
1768) Added possibility to change refresh rate of browsers when emulation is launched
1779) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
178-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
17910) Minor U.I cosmetic changes
18011) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
181-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
183Release 0 (5th January 2017)
1850) New option --debugger
1861) ELF format support
1872) ELF debug symbol support
1883) "Step Into" code function
1894) Menus layout dedicated to the debugger
1905) Added a dedicated main window for tracing (M68K)
1916) Added a Debugger tab in the config tab
1927) Visual Studio 2015 project support
1938) libelf-0.8.13 library support
1949) 64 bits debug executable only
197Known issues
1991) Video output is not displayed due to my OpenGL / QT5 5.5.1 integration with VS 2015 but solved when using the QT 5.9.1 package for VS 2017
2002) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
201-- Need to trace over the BPM or unset the BPM
202-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2033) DWARF 2 support
204-- With GCC: the code must be compiled with the -gdwarf-2 option
2054) The Local and Watch variables window may display not available type information or empty information
206-- Such missing information may be included in future release
207-- The 'const' type may not be reported correctly in the DWARF information
2085) The 2MB mirroring is no longer applied in case of --dram-max option usage
2096) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
210-- The application needs to set the SP (Stack) in accordance
2117) The Exception Vector Table window displays only 65 vectors
212-- Missing vectors may be added in future release
2138) User needs to manualy check if the Atari Jaguar executable match his source code files
214-- Otherwise, source code and assembly may not match or leads to instabilities
2159) The emulator needs to be restarted in case of the following actions occur
216-- Key bindings changes
217-- BIOS selection changes and without new executable load
21810) In the case of a ROM cartridge writing, and with occuring breakpoint, the PC pointer will point at the next instruction and not at the instruction causing the breakpoint
21911) Emulator will crash in case of wrong address value provided in the memory browser
22012) The RAM access log is limited to the 2MB
22113) In various occasions, global variables may be duplicated or without name in the DWARF information
222-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
22314) Source code disply only assembled code from vasm with option -dwarf
22415) After a new breakpoint set, the breakpoint list window is not refreshed
225-- User must perform an operation, such code tracing, to see the breakpoints list update
22616) Some ASCII characters may be not displayed correctly
227-- It depend how the text is displayed, this is related to the QT/HTML encoding done when reading DWARF file
24470541 22817) Potential legacy crash when leaving emulator in pause mode for a long period of time
230Cosmetic / UX issues
2321) The SP (Stack) icon color backgound doesn't look similar with the other ones
2332) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2343) Not every features have associated key bindings
236Legacy issues/hints
2381) Emulator seems to have easter egg(s)
239-- The option --yarrr displays a single message and end the application
240-- Pressing F8, while in the main window, will create an extra message in the log file
2412) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
243Project information
2451) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2462) Visual Studio 2015/2017 project support for 64 bits
2473) libelf 0.8.13 library 64bits for VS 2015/2017
2484) libdwarf 1.41 library 64bits for VS 2015, cygwin64 and Msys2/MinGW64
2495) QT 5.5.1 library 64bits for VS 2015
f951022b 2506) QT 5.12.0 library 64bits for VS 2017
2517) Zlib 1.2.8 library 64bits for VS 2015
2528) Zlib 1.2.11 library 64bits for VS 2017
2539) SDL 1.2.15 library 64bits for VS 2015/2017
25410) The original make files have been modified to follow the requirements and modifications
25511) The 'Rx' word has been added to the emulator name to make distinction with the official version
25612) The project is set at
25713) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
258-- Text / License terms are the same
261Download statistics
263jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
264jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
265No downloads statistics available for the Release 2
266No downloads statistics available for the Release 3