Document updates for the R3 release

Updated documents to fit with the R3 release.

diff --git a/docs/INSTALL b/docs/INSTALL
index 55fcdf5..e276312 100644 (file)
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -16,7 +16,7 @@ The minimum requirements for compiling Virtual Jaguar from source are:
  o  libcdio v0.90 or higher (optional, for Jaguar CD support)
  o  OpenGL libraries
  o  Qt 5.5.1 or higher
  o  libcdio v0.90 or higher (optional, for Jaguar CD support)
  o  OpenGL libraries
  o  Qt 5.5.1 or higher

- o  Visual Studio 2015 (if any of interest)
+ o  Visual Studio 2015 or 2017 (if any of interest)

  o  supported OS (WIN64 through msys2/MinGW64, Windows 64 bits); other
     OSs may work to but you may need to change some items in the Makefile or adapt the Visual Studio project.
  o  cygwin64 support is done but no test has been completed
  o  supported OS (WIN64 through msys2/MinGW64, Windows 64 bits); other
     OSs may work to but you may need to change some items in the Makefile or adapt the Visual Studio project.
  o  cygwin64 support is done but no test has been completed


@@ -82,10 +82,10 @@ cp -r ~/location-where-you-built-qt/src/gui/mac/qt_menu.nib virtualjaguar.app/Co
 Have fun!
 
 
 Have fun!
 
 

-NOTES FOR COMPILING UNDER VISUAL STUDIO 2015:
----------------------------------------------
+NOTES FOR COMPILING UNDER VISUAL STUDIO 2015 / 2017:
+----------------------------------------------------

 
 

-VS2015 sub-directory contains the projects and solution files
+Win-VS2015 & Win-VS2017 sub-directories contain the projects and solution files

 You may have to adapt such files to handle your own development environement,
 usualy to put the right include and library paths will be enough assuming you have all the requirements properly set.
 
 You may have to adapt such files to handle your own development environement,
 usualy to put the right include and library paths will be enough assuming you have all the requirements properly set.
 

diff --git a/docs/README b/docs/README
index fef9f0d..36d7796 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -94,7 +94,7 @@ but has also been extended and rewritten so that we can enjoy Atari Jaguar
 emulation on every platform that has a GCC compiler and a port of Qt.\r
 \r
 Currently Virtual Jaguar GCC/Qt Rx compiles on WIN64 using msys2/MinGW64,\r
 emulation on every platform that has a GCC compiler and a port of Qt.\r
 \r
 Currently Virtual Jaguar GCC/Qt Rx compiles on WIN64 using msys2/MinGW64,\r

-and Visual Studio 2015. Compiles also on cygwin64 but no tests have been done.\r
+and Visual Studio 2015/2017. Compiles also on cygwin64 but no tests have been done.\r

 It has previously compiled on WIN32 using mingw, and several UN*X based systems\r
 (BeOS, Linux, FreeBSD and MacOS). It may run on other\r
 systems as well but we can not guarantee that.\r
 It has previously compiled on WIN32 using mingw, and several UN*X based systems\r
 (BeOS, Linux, FreeBSD and MacOS). It may run on other\r
 systems as well but we can not guarantee that.\r

diff --git a/docs/WHATSNEW b/docs/WHATSNEW
index ec30fc9..7769e15 100644 (file)
--- a/docs/WHATSNEW
+++ b/docs/WHATSNEW
@@ -1,8 +1,71 @@
-Virtual Jaguar v2.1.3 Rx GCC/Qt
+Virtual Jaguar v2.1.3 R3 GCC/Qt

 -------------------------------
 
 -------------------------------
 

-* For an accurate update, please read the vj_ReleaseNotes.txt
+* Added an Exception Vector Table browser window
+* Modified the About window to update the credits list in a more appropriate way
+* Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
+* Added ui, alpine & debugger groups in the settings
+* Added the possibility to erase settings
+* Added the --es-all, --es-ui, --es-alpine & --es-debugger options to erase specific settings
+* Added a keybindings tab and adapted the configuration dialog tabs
+* Fixed a crash, in Release mode, when the HW labels setting is turn on
+* Fixed the SP (Stack) window UI potential missing data
+* Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
+* Keep the scrollbar position in accordance of the M68K PC pointer
+* Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
+* Improved the .heap section detection to avoid a detection error
+* Fixed a crash when DWARF information does references to missing source code files
+* Added a Local browser window for local variables
+
+
+Virtual Jaguar v2.1.3 R2 GCC/Qt
+-------------------------------
+
+* Added some error detections when reading the ELF executable file
+* Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
+* "Step Over" code function for BSR/JSR functions
+* Added the .debug_ranges detection to avoid a detection error
+* DWARF format support
+* Added an All Watch browser window for non-local variables
+* Added a heap allocator browser window based on my own memory allocation functions
+* Added additional 4 memory browser windows with address input based on hexa, decimal or symbol name
+* Windows refreshing executed only if windows is visible
+* Added a restart function
+* Updated the About window to update the credits list
+* Fixed (hacking) the display of the SP (Stack) memory browser
+* Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
+* Added some information in the --help/-h/-? option
+* --debugger option no longer force the log file
+* Added a --dram-max option to extend the DRAM size to 8MB
+* Added the "enter" key support when setting the BPM (Breapoint)
+* Save the windows positions, size and visibilities (show or hide) status
+
+
+Virtual Jaguar v2.1.3 R1 GCC/Qt
+-------------------------------
+
+* BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
+* Added SP (Stack) memory browser
+* User can change now the number of lines of disassembly displayed in the tracing window
+* User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
+* Added an emulator status window (GPU status, M68K debugger & tracking status)
+* Added a GPU disassembly tracing window - Display the current PC pointer
+* Added a DSP disassembly tracing window - Display the current PC pointer
+* Added possibility to change refresh rate of browser windows when emulation is launched
+* Display partial hardware labels (Internal Memory & Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
+* User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
+
+
+Virtual Jaguar v2.1.3 R0 GCC/Qt
+-------------------------------

 
 

+* New option --debugger
+* ELF format support
+* ELF debug symbol support
+* "Step Into" code function
+* Menus layout dedicated to the debugger
+* Added a dedicated main window for tracing (M68K)
+* Added a Debugger tab in the config tab

 
 
 Virtual Jaguar v2.1.3 GCC/Qt
 
 
 Virtual Jaguar v2.1.3 GCC/Qt

diff --git a/docs/vj_ReleaseNotes.txt b/docs/vj_ReleaseNotes.txt
index b609036..8ffe37b 100644 (file)
--- a/docs/vj_ReleaseNotes.txt
+++ b/docs/vj_ReleaseNotes.txt
@@ -1,5 +1,5 @@
-Release 3 (WiP)\r
----------------\r
+Release 3 (13th November 2017)\r
+------------------------------\r

 0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options\r
 1) Added an Exception Vector Table browser window\r
 2) Modified the About window to update the credits list in a more appropriate way\r
 0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options\r
 1) Added an Exception Vector Table browser window\r
 2) Modified the About window to update the credits list in a more appropriate way\r

diff --git a/src/gui/about.cpp b/src/gui/about.cpp
index 456abb7..10a31ce 100644 (file)
--- a/src/gui/about.cpp
+++ b/src/gui/about.cpp
@@ -47,7 +47,7 @@ AboutWindow::AboutWindow(QWidget * parent/*= 0*/): QWidget(parent, Qt::Dialog)
                "<br><br>"
                "<i>Rx version:<i>"
                "<br>"
                "<br><br>"
                "<i>Rx version:<i>"
                "<br>"

-               "<b>Flynn</b> for the debugger integration, ELF/DWARF format, Win64 & Visual Studio 2015 support"
+               "<b>Flynn</b> for the debugger integration, ELF/DWARF format, Win64 & Visual Studio 2015/2017 support"

                "<br><br>"
                "<i>The Virtual Jaguar team would like to express their gratitude to:</i>"
                "<br><br>"
                "<br><br>"
                "<i>The Virtual Jaguar team would like to express their gratitude to:</i>"
                "<br><br>"