Update documentation for RMV v1.7 release

Author: ahosier

BUILD.md

@@ -46,6 +46,7 @@ sudo apt-get install python3-pip
 pip install sphinx_rtd_theme
 sudo snap install cmake --classic
 sudo apt-get install git
+sudo apt-get install git-lfs
 sudo apt-get install python3-sphinx
 sudo apt-get install libxcb-xinerama0
 sudo apt-get install mesa-common-dev libglu1-mesa-dev
@@ -83,5 +84,25 @@ Alternatively, building can be done directly from the prebuild script with the -
 python3 pre_build.py --build
 ```
 
+It is possible to use the system-installed version of Qt rather than using a Qt installer described above. At the time of this writing, Ubuntu 22.04 LTS
+comes with Qt 5.15.3. To use the system Qt, a fake Qt package is needed. For Qt 5.15.3, this can be made by creating the required directory structure
+and setting up symbolic links to point to the system Qt lib and include directories:
+```bash
+mkdir -p ~/Qt/Qt5.15.3/5.15.3/gcc_64
+sudo ln -s /usr/lib/x86_64-linux-gnu ~/Qt/Qt5.15.3/5.15.3/gcc_64/lib
+sudo ln -s /usr/include/x86_64-linux-gnu/qt5 ~/Qt/Qt5.15.3/5.15.3/gcc_64/include
+```
+python3 pre_build.py --qt 5.15.3 --qt-system --disable-extra-qt-lib-deploy --build
+
+Some additional Qt components may be required, so install those:
+
+```
+sudo apt-get install qtbase5-dev
+sudo apt-get install qtbase5-dev-tools
+sudo apt-get install libqt5svg5-dev
+sudo apt-get install libqt5x11extras5
+sudo apt-get install qtbase5-private-dev
+```
+
 [qt-online]: https://www.qt.io/blog/qt-5.15.2-released
 [qt-offline]: https://download.qt.io/archive/qt/5.12/5.12.6/

NOTICES.txt

@@ -15,7 +15,7 @@ The Radeon Memory Visualizer (RMV) is a software tool that will allow users to a
    * Start your application. The Radeon Developer Panel will switch to the "APPLICATIONS" tab. The overlay window in the top left of the application being traced will show if RMV tracing is enabled. If not, make sure the app is running in Vulkan® or DirectX®12 mode.
    * When tracing is complete, click on the 'Memory Trace' tab and click "Dump Trace" or close your application (in this case, the trace will be dumped automatically).
 4. For further detailed instructions, please see the documentation provided in the Help. Help can be found in the following locations:
-   * Help web pages exist in the "docs" sub directory
+   * Help web pages exist in the "help" sub directory
    * Help web pages can be accessed from the **Help** button (?) in the Developer Panel
    * Help web pages can be accessed from the Welcome screen in the Radeon Memory Visualizer, or from the **Help** menu
    * The documentation is hosted publicly at:
@@ -31,12 +31,7 @@ The Radeon Memory Visualizer (RMV) is a software tool that will allow users to a
 * AMD Radeon RX 7000 series
 * AMD Radeon RX 6000 series
 * AMD Radeon RX 5000 series
-* AMD Radeon VII
-* AMD RX Vega 64 and RX Vega 56
-* AMD Ryzen™ Processors with Radeon Vega Graphics
-* AMD Radeon R9 Fury and Nano series
-* AMD Radeon RX 400, RX 500 series
-* AMD Tonga R9 285, R9 380
+* AMD Ryzen™ Processors with Radeon Graphics
 
 ## Supported Operating Systems
 * Windows® 10
@@ -48,8 +43,7 @@ Note: Before running RDP and capturing an RMV memory trace on Linux, be sure to
 ## Required hardware for SAM (Smart access memory) support
 * AMD Radeon RX 7000 series
 * AMD Radeon RX 6000 series
-* AMD Ryzen 5000 series processors
-* AMD Ryzen 3000 series processors (except for the Ryzen 5 3400G and Ryzen 3 3200G)
+* AMD Ryzen 5000 and higher series processors with Radeon Graphics
 
 ## Build instructions
 See [BUILD.md](BUILD.md) for more details.
@@ -58,7 +52,7 @@ See [BUILD.md](BUILD.md) for more details.
 For support, please visit the RMV repository github page: https://github.com/GPUOpen-Tools/radeon_memory_visualizer
 
 ## License ##
-Radeon Memory Visualizer is licensed under the MIT license. See the [License.txt](License.txt) file for complete license information.
+Radeon Memory Visualizer is licensed under the MIT license. See the [LICENSE.txt](LICENSE.txt) file for complete license information.
 
 ## Copyright information ##
 Please see [NOTICES.txt](NOTICES.txt) for third party license information.

README.md

@@ -1,10 +1,14 @@
-Radeon™ Memory Visualizer V1.6.1 05-24-2023
--------------------------------------------
+Radeon™ Memory Visualizer V1.7 09/21/2023
+-----------------------------------------
 
-V1.6.1 Changes
+V1.7 Changes
 ------------------------------------
-1) Add support for an upcoming driver release.
-2) Bug/stability fixes.
+1) Aliased Resource size calculation improvements on Resource overview pane.
+2) Support for loading Radeon GPU Detective crash dump files.
+3) Resource naming and implicit buffer filtering made more reliable in DX12.
+4) Support for hours added (formatted as "H:MM:SS.clk_cycles" and included with the CTRL+T time-cycling shortcut keys).
+5) System memory type added to device configuration pane (e.g. DDR4).
+6) Bug/stability fixes.
 
 Known Issues
 ------------------------------------
@@ -24,6 +28,11 @@ Known Issues
 Release Notes History
 ------------------------------------
 
+V1.6.1 Changes
+------------------------------------
+1) Add support for an upcoming driver release.
+2) Bug/stability fixes.
+
 V1.6 Changes
 ------------------------------------
 1) Additional parameters added to the resource history table in the resource details pane.

Release_Notes.txt renamed to RELEASE_NOTES.txt

@@ -0,0 +1,3 @@
+.wy-nav-content {
+    max-width: none;
+}

documentation/source/_static/style.css

@@ -0,0 +1,4 @@
+{% extends "!layout.html" %}
+{% block extrahead %}
+    <link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
+{% endblock %}

documentation/source/_templates/layout.html

@@ -54,16 +54,16 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'1.6.1'
+version = u'1.7.0'
 # The full version, including alpha/beta/rc tags.
-release = u'1.6.1'
+release = u'1.7.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -110,7 +110,7 @@
 # file works better with read the docs (more so than specifying it via the
 # html_context tag)
 def setup(app):
-    app.add_stylesheet('theme_overrides.css')
+    app.add_css_file('theme_overrides.css')
 
 html_show_sourcelink = False
 html_show_sphinx = False

documentation/source/conf.py

@@ -3,39 +3,30 @@ The Radeon™ Memory Visualizer (RMV)
 
 The Radeon Memory Visualizer is a memory optimization tool that can be used by
 developers to optimize memory usage for DirectX® 12, Vulkan™ applications for
-AMD GCN and RDNA™ hardware.
+AMD RDNA™ hardware.
 
 This document describes how the Radeon Memory Visualizer can be used to
 examine a memory trace file.
 
-Supported graphics APIs, RDNA and GCN hardware, and operating systems
----------------------------------------------------------------------
+Supported graphics APIs, RDNA hardware, and operating systems
+-------------------------------------------------------------
 
 **Supported APIs**
 
 -  DirectX 12
 
 -  Vulkan
 
-\ **Supported RDNA and GCN hardware**
+\ **Supported RDNA hardware**
 
 -  AMD Radeon RX 7000 series
 
 -  AMD Radeon RX 6000 series
 
 -  AMD Radeon RX 5000 series
 
--  AMD Radeon VII
+-  AMD Ryzen™ Processors with Radeon Graphics
 
--  AMD RX Vega 64 and RX Vega 56
-
--  AMD Ryzen™ Processors with Radeon Vega Graphics
-
--  AMD Radeon R9 Fury and Nano series
-
--  AMD Radeon RX 400 and RX 500 series
-
--  AMD Tonga R9 285, R9 380
 
 \ **Supported Operating Systems**
 
@@ -61,6 +52,14 @@ There are a few ways to load a trace into RMV.
 
 1) Use the “File/Open trace” pull down menu, or the “File/Recent
    trace” pull down menu item.
+   
+  Note that RMV is also capable of loading Radeon GPU Detective (.rgd) files.
+  In order to view .rgd file names in the File open dialog box, be sure to select
+  "RGD crash dump files (*.rgd)" in the file filter dropdown listbox.  RGD files
+  load all the same types of data as RMV files, however, they are opened in
+  read-only mode (i.e., created snapshots are not saved).
+
+.. image:: media/open_file_rgd.png
 
 2) Go to the “Welcome” view and click on the “Open a Radeon Memory
    trace…”