Added a date creation stamp in the application command line information
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_HistoryNotes.txt
CommitLineData
fe41cce0
JPM
1Release 5 (TBA)
2---------------
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
5
6Release 4a (15th August 2019)
7-----------------------------
8Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
f04df4f1
JPM
9-
100) Fix specific breakpoint for ROM cartridge or unknown memory location writing
11
12Release 4 (10th August 2019)
13----------------------------
14Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
1081a838
JPM
15-
160) The zoom value setting has been fixed in the registry
171) Debugger mode now shares the same alpine rom path setting
182) Local variables window displays register name now
193) Switch to Zlib 1.2.11 static library 64bits for VS 2017
204) Switch to SDL 1.2.15 static library 64bits for VS 2017
215) Local variables window displays values from function's parameters
226) Fixed the typedef's name display in Local and Watch variables window
237) Breakpoint may now occur in case of a ROM cartridge writing
24-- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
25-- 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
268) Local variables window detects now if a variable is used or not by the code
279) The address provided in the debugger memory windows is now verified to prevent crash
28-- Wrong address will be displayed in red
2910) UI changes
30-- Added new icons for the exit and status features
31-- Modified icons for the SP (Stack) browser
32-- Unified icons sizes depend on their usage (drop down menu and main menu)
33-- Underline the active M68K line in the disassembly window
34-- Allow the up/down navigation on the SP (Stack) browser
35-- Restart function cleans-up the SP (Stack) browser and the heap allocator system
36-- Fixed the up navigation on the memory window
3711) Added some log information for the emulator initialisations
3812) Breakpoint will happen in case of writing at unknown memory location
39-- Alert box will display a message and then the code will stop
4013) Added the DRAM size in the emulator status window
4114) Debugger sources code clean-up
4215) Added a call stack feature
4316) Follow platform requirement to prevent source file reading issue
4417) UI modifications
45-- Modified icon for the memory window to make a distinction with the memory browser
46-- The all watch, and Exception Vector Table windows, can be closed using keyboard
47-- Renamed the debugger dedicated icons to make a distinction
48-- Added the call stack window
4918) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
50-- Previously used ELF/DWARF information was still accessible
5119) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
5220) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
5321) Added a Jaguar model and BIOS configuration tab
5422) Jaguar model and BIOS configuration integration
5523) Added LEB128 decoding functions
56-- It is used for the DWARF decoding information
5724) Debugger support improvement
58-- DWARF support for the enum type (partial), structure and subroutine type
59-- Debugger can report variable's unsigned char value
6025) UI modifications
61-- Added a status bar, better status report & information display for the heap allocation window
62-- Added a status bar, better status report & information display for the local variables window
63-- Added better information display for the exception vectors table window, and added some missing vectors
64-- Added a status bar, better status report & information display for the call stack window
65-- Added a status bar, better status report & information display for the all watches window
6626) Added screenshot feature
67-- Not accessible in debugger mode
68-- Added screenshot editable path in the general tab, and a key binding
6927) Minor misspellings fixes
7028) DWARF source code directory path clean-up
7129) Added a source code files list viewer
72-- List comes from the DWARF information
7330) Check potential variables missing/incomplete description found in the DWARF information
74-- No crash involved but can help to reduce such as variables duplicate or the blank ones
7531) Added a sorting filter in the all watches window
7632) Improve source code file reading to avoid additional text/bytes reading
7733) Help & content texts updates
7834) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
7935) Added the support for the used lines source's DWARF structure
80-- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
8136) Added the Rx version's contact in the help text
8237) Added search paths in case of missing DWARF directories information
83-- Used to look for the file(s)
8438) Setup CU's low/high PC in case of the DWARF structures doesn't have it
85-- Used mostly to allow display the source assembled with vasm
8639) Added function name support from ELF structure
8740) Added the return address information in the call stack
8d705db0 8841) Added multiple breakpoints feature, and their key bindings, for functions only
24470541 8942) Added timer initialisation for the SDL setup
f99a6ebc 9043) Added a cartridge view menu
24470541 91-- Added a window to display my own directory and his files list
6642f781 9244) Debugger sources code clean-up
acd3342f 9345) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
f951022b 9446) Fix crash with potential missing DWARF structure tag's type name
c57d3e56
JPM
9547) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
9648) Project has switched to QT 5.12.0 library 64bits for VS 2017
3323d78b 9749) Added a Save Dump As... feature to save a memory zone to a file
9c4d8f10
JPM
9850) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
99-- -d has been renamed by -D because another -d was also used for the dsp command line option
8d705db0 10051) Removed the sorting filter in the all watches window
96bd5390 10152) Fix the support of the DRAM size limit option in the heap allocation window
f99a6ebc 10253) Set cartridge view menu for debugger mode only
8b11a1b0 10354) Prevent crash in case of call stack is out of range
1081a838
JPM
104
105Release 3 (13th November 2017)
106------------------------------
107Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
108-
1090) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
1101) Added an Exception Vector Table window
1112) Modified the About window to update the credits list in a more appropriate way
112-- Updated the emulator application credits line
1133) Added 'Rx' word to the emulator name
1144) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
1155) Added ui, alpine and debugger groups in the settings
1166) Added the possibility to erase settings
1177) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
1188) Added a key bindings tab and adapted the configuration dialog tabs
119-- User can modify the key bindings where appropriate
120-- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
1219) Fixed a crash, in Release mode, when the HW labels setting is turn on
12210) Solved an interference between the HW labels setting and the one used by the debugger
123-- The setting is now only the reference used
12411) Fixed the SP (Stack) browser UI potential missing data
12512) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
12613) Keep the scrollbar position in accordance of the M68K PC pointer
127-- UI displays the source without the need to move down/up the scrollbar
12814) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
129-- This may come from the linker vlink
13015) Improved the .heap section detection to avoid a detection error
131-- Depend vlink version, .heap section may have an Alloc flag
13216) Fixed a crash when DWARF information does references to missing source code files
13317) Added a local variables window
13418) Project has switched to Visual Studio 2017 and QT 5.9.1 library
135
136Release 2 (3rd September 2017)
137------------------------------
1380) Added some error detections when reading the ELF executable file
1391) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
1402) "Step Over" code function for BSR/JSR functions
1413) Added the .debug_ranges detection to avoid a detection error
1424) DWARF support
143-- TAG: Compilation Unit, Subprogram, Variables, Types
144-- Line numbers, symbols, functions
1455) Added an All Watch window for non-local variables
1466) Added a heap allocator window based on my own memory allocation functions
1477) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
1488) Windows refreshing executed only if windows is visible
1499) Added a restart function
150-- Restart only the 68000 program counter to his original set
15110) Modified the icons color backgound for the "Step In" and "Step Over" functions
15211) Updated the About window to update the credits list
15312) 64 bits Release executable
15413) Fixed (hacking) the display of the SP (Stack) browser
15514) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
156-- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
15715) Added some information in the --help/-h/-? option
15816) --debugger option no longer force the log file
15917) Added a --dram-max option to extend the DRAM size to 8MB
16018) Added the "enter" key support when setting the BPM (Breapoint)
16119) Save the windows positions, size and visibilities (show or hide) status
162-- Such windows will automatically respawn in the next emulator launch
163
164Release 1 (12th February 2017)
165------------------------------
1660) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
1671) Clean-up the tracing / no-tracing flags for better U.I understanding
1682) Added SP (Stack) browser
1693) User can change now the number of lines of disassembly displayed in the tracing window
1704) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
1715) Added an emulator status window (GPU status, M68K debugger and tracking status)
1726) Added a GPU disassembly tracing window - Display the current PC pointer
1737) Added a DSP disassembly tracing window - Display the current PC pointer
1748) Added possibility to change refresh rate of browsers when emulation is launched
1759) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
176-- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
17710) Minor U.I cosmetic changes
17811) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
179-- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
180
181Release 0 (5th January 2017)
182----------------------------
1830) New option --debugger
1841) ELF format support
1852) ELF debug symbol support
1863) "Step Into" code function
1874) Menus layout dedicated to the debugger
1885) Added a dedicated main window for tracing (M68K)
1896) Added a Debugger tab in the config tab
1907) Visual Studio 2015 project support
1918) libelf-0.8.13 library support
1929) 64 bits debug executable only
193
194
195Known issues
196============
1971) 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
1982) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
199-- Need to trace over the BPM or unset the BPM
200-- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
2013) DWARF 2 support
202-- With GCC: the code must be compiled with the -gdwarf-2 option
2034) The Local and Watch variables window may display not available type information or empty information
204-- Such missing information may be included in future release
205-- The 'const' type may not be reported correctly in the DWARF information
2065) The 2MB mirroring is no longer applied in case of --dram-max option usage
2076) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
208-- The application needs to set the SP (Stack) in accordance
2097) The Exception Vector Table window displays only 65 vectors
210-- Missing vectors may be added in future release
2118) User needs to manualy check if the Atari Jaguar executable match his source code files
212-- Otherwise, source code and assembly may not match or leads to instabilities
2139) The emulator needs to be restarted in case of the following actions occur
214-- Key bindings changes
215-- BIOS selection changes and without new executable load
21610) 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
21711) Emulator will crash in case of wrong address value provided in the memory browser
21812) The RAM access log is limited to the 2MB
21913) In various occasions, global variables may be duplicated or without name in the DWARF information
220-- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
22114) Source code disply only assembled code from vasm with option -dwarf
22215) After a new breakpoint set, the breakpoint list window is not refreshed
223-- User must perform an operation, such code tracing, to see the breakpoints list update
22416) Some ASCII characters may be not displayed correctly
225-- It depend how the text is displayed, this is related to the QT/HTML encoding done when reading DWARF file
24470541 22617) Potential legacy crash when leaving emulator in pause mode for a long period of time
1081a838
JPM
227
228Cosmetic / UX issues
229====================
2301) The SP (Stack) icon color backgound doesn't look similar with the other ones
2312) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
2323) Not every features have associated key bindings
233
234Legacy issues/hints
235===================
2361) Emulator seems to have easter egg(s)
237-- The option --yarrr displays a single message and end the application
238-- Pressing F8, while in the main window, will create an extra message in the log file
2392) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
240
241Project information
242===================
2431) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
2442) Visual Studio 2015/2017 project support for 64 bits
2453) libelf 0.8.13 library 64bits for VS 2015/2017
2464) libdwarf 1.41 library 64bits for VS 2015, cygwin64 and Msys2/MinGW64
2475) QT 5.5.1 library 64bits for VS 2015
f951022b 2486) QT 5.12.0 library 64bits for VS 2017
1081a838
JPM
2497) Zlib 1.2.8 library 64bits for VS 2015
2508) Zlib 1.2.11 library 64bits for VS 2017
2519) SDL 1.2.15 library 64bits for VS 2015/2017
25210) The original make files have been modified to follow the requirements and modifications
25311) The 'Rx' word has been added to the emulator name to make distinction with the official version
25412) The project is set at https://github.com/djipi/Virtual-Jaguar-Rx
25513) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
256-- Text / License terms are the same
257
258
259Download statistics
260-------------------
261jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
262jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
263No downloads statistics available for the Release 2
264No downloads statistics available for the Release 3