Skip to content

Commit 1ff78f3

Browse files
committed
Update documentation for RMV 1.4 release.
1 parent 8382468 commit 1ff78f3

File tree

5 files changed

+21
-6
lines changed

5 files changed

+21
-6
lines changed

documentation/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
# built documents.
5555
#
5656
# The short X.Y version.
57-
version = u'1.3.0'
57+
version = u'1.4.0'
5858
# The full version, including alpha/beta/rc tags.
59-
release = u'1.3.0'
59+
release = u'1.4.0'
6060

6161
# The language for content autogenerated by Sphinx. Refer to documentation
6262
# for a list of supported languages.

documentation/source/heap_overview.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,24 @@ using and where that memory is allocated. It can be used to very quickly
77
determine if the application is using too much memory of a certain type
88
and if the correct memory type is being used where it should be.
99

10+
RMV is able to detect if a memory trace was taken from a system with
11+
Smart Access Memory (SAM) enabled. SAM gives the CPU direct access to
12+
all available video memory. More information on SAM can be found in the
13+
GPUOpen article, "How to get the most out of Smart Access Memory" located
14+
at https://gpuopen.com/learn/get-the-most-out-of-smart-access-memory/
15+
16+
The top line of the Heap overview pane indicates if SAM is enabled or
17+
disabled.
18+
19+
When SAM is disabled, the display is split into 3 sections, one section per
20+
heap type. There is a brief description of the use for each heap.
21+
1022
.. image:: media/snapshot/heap_overview_1.png
1123

12-
The display is split into 3 sections, one section per heap type. There is
13-
a brief description of the use for each heap.
24+
When SAM is enabled, the section for the invisible heap is not shown since
25+
all memory is visible to the CPU.
26+
27+
.. image:: media/snapshot/heap_overview_2.png
1428

1529
On the left is the amount of memory used for each heap type as a series
1630
of bar graphs:
-17.8 KB
Loading
57 KB
Loading

documentation/source/timeline.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,9 @@ time and returning back to the **Snapshot generation** will now show the table
110110
fully populated for the selected snapshot.
111111

112112
Right-clicking on a snapshot in the table will show a context menu allowing the snapshot
113-
to be renamed or deleted. Snapshots are saved back to the trace file so they can be
114-
viewed at a later date.
113+
to be renamed or deleted. Snapshots can be renamed using any printable ASCII character,
114+
including spaces. Snapshot names are limited to 32 characters. Snapshots are saved back
115+
to the trace file so they can be viewed at a later date.
115116

116117
Two or more snapshots can be selected in the table by holding down the shift key to
117118
select a range of snapshots or pressing Ctrl to select individual snapshots.

0 commit comments

Comments
 (0)