Update documentation for RMV 1.2 release.

Author: ahosier

License.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2020 Advanced Micro Devices, Inc.
+Copyright (c) 2017-2021 Advanced Micro Devices, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -104,4 +104,4 @@ CMake is a registered trademark of Kitware, Inc.
 Qt and the Qt logo are registered trademarks of the Qt Company Ltd and/or its subsidiaries worldwide.
 
 
-© 2020 Advanced Micro Devices, Inc. All rights reserved.
+© 2020-2021 Advanced Micro Devices, Inc. All rights reserved.

Release_Notes.txt

@@ -1,16 +1,12 @@
-Radeon Memory Visualizer V1.1 11-24-2020
+Radeon Memory Visualizer V1.2 07-20-2021
 ----------------------------------------
 
-V1.1 Changes
+V1.2 Changes
 ------------------------------------
 
-1) Add support for showing aliased resources in the allocation overview and allocation explorer panes.
-2) Rework the resource "Filter by size" slider throughout so that the resources are more evenly distributed.
-3) Empty tables show a graphical indication and description as to why the table is empty.
-4) Add "color by commit type" coloring mode.
-5) Add search box and filter by allocation size to the allocation table in the allocation explorer pane.
-6) Show unmapped resource memory in residency donut in the resource details pane.
-7) Bug/stability fixes.
+1) Add tooltips showing resource details on the Resource overview pane.
+2) Add range-based address searching for resource tables.
+3) Bugs/stability fixes.
 
 Known Issues
 ------------------------------------
@@ -20,13 +16,24 @@ Known Issues
 (2) In the Snapshots|Resource details pane, Physical memory mapped events may be shown before virtual allocate events.
 (3) Some of the Pane navigation shortcuts may conflict with the keyboard shortcuts used by the Radeon Settings (such as ALT-R). It is recommended to remap the Radeon settings so they don't conflict.
 (4) Some UI elements do not rescale properly when the OS's DPI scale settings are dynamically changed, or when dragging RMV between two monitors with different DPI scales. Close and re-open RMV to view at proper sizes.
-(5) Running multiple instances of the Radeon Developer Panel is not supported.
+(5) Running multiple instances of the Radeon Developer Panel is not supported. This is also true when running the Radeon Developer Panel supplied with RMV at the same time as the Radeon Developer Panel supplied with the Radeon GPU Profiler.
 (6) Sparse texture are not fully supported.
 (7) When tracing an application that uses a launcher, or an application that creates multiple devices, it is possible that more than one trace file will be written to disk. In the case of the launcher, adding the launcher's executable name to the Blocked applications list in the Radeon Developer Panel should prevent multiple trace files. Restarting the Radeon Developer Panel may be required before attempting to trace again.
 
 Release Notes History
 ------------------------------------
 
+V1.1 Changes
+------------------------------------
+
+1) Add support for showing aliased resources in the allocation overview and allocation explorer panes.
+2) Rework the resource "Filter by size" slider throughout so that the resources are more evenly distributed.
+3) Empty tables show a graphical indication and description as to why the table is empty.
+4) Add "color by commit type" coloring mode.
+5) Add search box and filter by allocation size to the allocation table in the allocation explorer pane.
+6) Show unmapped resource memory in residency donut in the resource details pane.
+7) Bug/stability fixes.
+
 V1.0
 ------------------------------------
 This is the first public release of the Radeon Memory Visualizer.

documentation/source/allocation_explorer.rst

@@ -9,6 +9,9 @@ by size using the "**Filter by size**" slider to the right of the search box.
 Clicking on an allocation will show it in the graphic below, along with a
 representation of all of the resources in the selected allocation.
 
+Mousing over a memory size cell in either table will display a tooltip showing
+the number of bytes.
+
 .. image:: media/snapshot/allocation_explorer_1.png
 
 The coloring can be changed using the "**color by ..**" combo box above the

documentation/source/conf.py

@@ -46,17 +46,17 @@
 
 # General information about the project.
 project = u'Radeon Memory Visualizer'
-copyright = u'2018-2020, Advanced Micro Devices, Inc. All rights reserved.'
+copyright = u'2018-2021, Advanced Micro Devices, Inc. All rights reserved.'
 author = u'AMD Developer Tools'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'1.1.0'
+version = u'1.2.0'
 # The full version, including alpha/beta/rc tags.
-release = u'1.1.0'
+release = u'1.2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

documentation/source/heap_overview.rst

@@ -24,7 +24,7 @@ the memory type is oversubscibed or is close to being oversubscribed.
 The 'total size' bar shows the total amount of physical memory in the heap.
 
 The 'used' bar shows how much memory the application is using in dark gray.
-The lighter gray to the right indicates the total amound of memory used by all
+The lighter gray to the right indicates the total amount of memory used by all
 processes in the system.
 
 The middle column shows a series of statistics for the heap memory type, such

documentation/source/index.rst

@@ -237,4 +237,4 @@ Microsoft is a registered trademark of Microsoft Corporation in the US and other
 Windows is a registered trademark of Microsoft Corporation in the US and other jurisdictions.
 
 
-© 2020 Advanced Micro Devices, Inc. All rights reserved.
+© 2018-2021 Advanced Micro Devices, Inc. All rights reserved.

documentation/source/resource_list.rst

@@ -21,4 +21,14 @@ The search box allows for resources to be filtered by any text which is
 present in the table. Any resources which do not match the text filter will not
 be displayed.
 
+Searching any of the resource tables in RMV now adds a range-based search in
+addition to text searching. For example, if a virtual address is 0x1000 with a
+size of 256 bytes, entering the search text as 0x1001 will include this resource
+since it is in the address range. This is useful for seeing if memory locations
+are used by multiple resources. Range-based searching will work with either
+decimal or hexadecimal numbers.
+
+Mousing over a memory size cell in the table will display a tooltip showing the
+exact number of bytes.
+
 .. image:: media/snapshot/resource_list_1.png

documentation/source/resource_overview.rst

@@ -10,6 +10,16 @@ or preferred heap for example).
 
 .. image:: media/snapshot/resource_overview_1.png
 
+Mousing over the resources will darken the resource under the mouse, and a
+tooltip will show pertinent information for the resource. If resources appear
+very small on the screen, the **Filter by size** slider bar can be used to
+filter out very large or very small resources.
+
+Clicking on a resource will show details about it at the bottom of the pane,
+including various attributes and where the selected resource lies in its
+corresponding allocation. Most of this information is now available in the
+tooltip.
+
 The preferred heap drop down list allows you to select resources you want to
 include in the resource view according to which heap was the preferred container
 for the resource at the time the resource was created. You can do this by
@@ -56,10 +66,6 @@ There are also 3 slicing combo boxes. These allow you to group resources by some
 attribute. The first slicing mode applies to all the resources. The other 2 slicing
 modes are applied to the groups set up by the previous slicing mode.
 
-Clicking on a resource will show details about it at the bottom of the pane,
-including various attributes and where the selected resource lies in its
-corresponding allocation.
-
 The screenshot below shows slicing and coloring resources depending whether they
 are in the preferred heap. You can tell instantly if resources are where you'd
 expect them to be and if not, investigate further by double-clicking on the resource

documentation/source/timeline.rst

@@ -103,11 +103,11 @@ table below the graph. Notice that only the snapshot name is shown in the
 table; the other table entries will be created when the snapshot is viewed.
 
 Clicking on the snapshot in the table or on the timeline will select that snapshot.
-Clicking on the **SNAPSHOT** tab will show further information about the selected
-snapshot. Double-clicking on a snapshot on the table or on the graph will jump to the
-**Heap overview** pane on the **SNAPSHOT**. This process will generate the snapshot data
-at the required time and returning back to the **Snapshot generation** will now
-show the table fully populated for the selected snapshot.
+Clicking on the **SNAPSHOT** tab with a snapshot selected, or double-clicking on a
+snapshot on the table or on the graph will jump to the **Heap overview** pane on
+the **SNAPSHOT**. This process will generate the snapshot data at the required
+time and returning back to the **Snapshot generation** will now show the table
+fully populated for the selected snapshot.
 
 Right-clicking on a snapshot in the table will show a context menu allowing the snapshot
 to be renamed or deleted. Snapshots are saved back to the trace file so they can be
@@ -118,7 +118,13 @@ select a range of snapshots or pressing Ctrl to select individual snapshots.
 If 2 snapshots are selected, right-clicking on the table while holding down the Ctrl
 key will display a context menu to allow them to be compared. Alternatively, the
 **Compare snapshots** button in the top right will become active. Clicking on either
-will jump to the **Snapshot delta** pane in the **COMPARE** tab.
+will jump to the **Snapshot delta** pane in the **COMPARE** tab. Alternatively, selecting
+2 snapshots in the table and clicking on the **COMPARE** tab will do the same thing. The
+snapshots will be compared as **base snapshot vs diff snapshot**, where the base snapshot
+is the last (or highlighted) snapshot that was selected, and the diff snapshot is the
+first snapshot selected. If no snapshot is highlighted or the last snapshot was
+deselected (in the case where three snapshots are selected and one of those is
+deselected), the snapshots will be compared in the order they appear in the table.
 
 **RGP Interop**