Update documentation for v1.10 release

Author: ahosier

NOTICES.txt

@@ -68,7 +68,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
-Qt v5.12.6 (LGPL v3) 
+Qt v6.7.0 (LGPL v3)
 GNU LESSER GENERAL PUBLIC LICENSE
 Version 3, 29 June 2007
 

RELEASE_NOTES.txt

@@ -1,15 +1,11 @@
-Radeon™ Memory Visualizer V1.9 04/24/2024
------------------------------------------
+Radeon™ Memory Visualizer V1.10 07/01/2024
+------------------------------------------
 
-V1.9 Changes
+V1.10 Changes
 ------------------------------------
-1) Improved resource list sorting.
-2) Implicit resource detection for heap resources.
-3) Conversion of heaps to resource buffers disabled if implicit heap detection is available.
-4) Improved "Filter by size" sliders shown with min and max values.
-5) Named virtual allocations.
-6) The default timeline has been changed to "Virtual memory heap" and the "Committed memory" timeline view has been removed.
-7) Bug/stability fixes.
+1) Updated to use Qt 6.7.0.
+2) Show/hide usage types on the Resource usage size and Resource usage count timeline views.
+3) Bug/stability fixes.
 
 Known Issues
 ------------------------------------
@@ -29,6 +25,16 @@ Known Issues
 Release Notes History
 ------------------------------------
 
+V1.9 Changes
+------------------------------------
+1) Improved resource list sorting.
+2) Implicit resource detection for heap resources.
+3) Conversion of heaps to resource buffers disabled if implicit heap detection is available.
+4) Improved "Filter by size" sliders shown with min and max values.
+5) Named virtual allocations.
+6) The default timeline has been changed to "Virtual memory heap" and the "Committed memory" timeline view has been removed.
+7) Bug/stability fixes.
+
 V1.8 Changes
 ------------------------------------
 1) The Resource usage size timeline calculations take resource aliasing into account.

documentation/source/allocation_explorer.rst

@@ -0,0 +1,78 @@
+Compare windows
+===============
+
+These panes allow the user to compare snapshots to see how allocations and
+resources have changed over time.
+
+Snapshot delta
+--------------
+
+The snapshot delta gives a high level overview of the differences between two
+snapshots. It shows the difference in the number of allocations and resources
+for each heap type.
+
+The carousel works in a similar way to the carousel in the **Resource list** pane
+but now shows the differences between the 2 snapshots, indicating such things as
+whether memory consumption has gone up or down.
+
+The "**Switch snapshots**" button in the top right corner under the settings
+tab can be used to switch the snapshots.
+
+.. image:: media/compare/snapshot_delta_1.png
+
+Memory leak finder
+------------------
+
+This pane shows the list of resources from both snapshots and allows them to be
+filtered depending on whether they are unique to one snapshot or present in
+both. This filtering can be achieved using the 3 checkboxes at the top. For example,
+just selecting the middle checkbox will show resources common to both snapshots.
+Underneath each checkbox is a summary of the number of resources that the checkbox
+represents and the total amount of memory used for that checkbox. For example, the
+left-most checkbox will show resources that are only present in the first snapshot.
+
+As with the other panes, search strings and the "**Filter by size**" slider can be
+used to narrow down the list of resources.
+
+Double-clicking on a resource will navigate to the **Resource details** pane and
+allow the snapshot to be viewed in the SNAPSHOT tab. If a resource is common to
+both snapshots, the base snapshot will be used.
+
+.. image:: media/compare/memory_leak_finder_1.png
+
+
+Vulkan resource naming
+----------------------
+Pipelines, images and buffers can be given unique names and these names will
+show up in the RMV UI. The Vulkan extension VK_EXT_debug_utils can be used for this.
+
+For more information, see the document:
+
+https://www.lunarg.com/wp-content/uploads/2018/05/Vulkan-Debug-Utils_05_18_v1.pdf
+
+specifically the section "Naming Objects"
+
+DirectX 12 resource naming
+--------------------------
+Memory traces for DirectX applications captured with the Radeon Developer Panel
+can include unique names for resources like heaps, buffers and textures.  Names can be assigned to
+DirectX resources using the ``ID3D12Object::SetName()`` method.
+For more information, please review the Microsoft DirectX 12 documentation.
+
+Calling the ``SetName()``
+method results in ETW (Event Tracing for Windows) events being emitted and picked
+up by the Panel. This resource naming information is then included in the RMV trace
+file.
+
+Due to the asynchronous nature of the event tracing, memory events that happen a short time before the process exit
+may show up incorrectly in RMV in terms of naming, as well as
+marking and filtering out implicit heaps (created for committed resources)
+and implicit buffers (that D3D12 runtime creates automatically for every explicitly created heap).
+To overcome this problem, it is recommended to introduce a delay of few seconds
+between memory events of interest and the process exit.
+
+Viewing resource names
+----------------------
+The resource names will show up in the RMV UI in the resource list pane, for example:
+
+.. image:: media/vk_resource_naming_1.png

documentation/source/allocation_overview.rst

@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'1.9.0'
+version = u'1.10.0'
 # The full version, including alpha/beta/rc tags.
-release = u'1.9.0'
+release = u'1.10.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.