Skip to content

Commit

Permalink
Bug 582308 Add description information to snapshot details
Browse files Browse the repository at this point in the history 
Add context help - also for other parts.

Task-Url: https://bugs.eclipse.org/bugs/show_bug.cgi?id=582308
Change-Id: I5b7d4539d8cda1d93f1547796ca6c81c1453b246
  • Loading branch information
@ajohnson1
ajohnson1 committed Nov 4, 2023
1 parent aab3ffb commit 0dff02f
Show file tree
Hide file tree
Showing 14 changed files with 369 additions and 57 deletions.
37 changes: 33 additions & 4 deletions plugins/org.eclipse.mat.ui.help/context.xml
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.contexts"?><!--
<?NLS TYPE="org.eclipse.help.contexts"?>
<!--
Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
SAP AG - initial API and implementation
IBM Corporation - additional context help
-->


<contexts>
<context id="oql">
<description>Object Query Language (OQL) Syntax</description>
Expand Down Expand Up @@ -74,4 +75,32 @@
<topic label="Collect information about the Memory Analyzer tool process"
href="reference/support.html" />
</context>
<context id="workbench_heapeditor">
<description>The main editor window for displaying information about a snapshot and running queries and reports.</description>
<topic href="reference/workbench.html#ref_workbench__heapeditor" label="Heap Editor"/>
</context>
<context id="workbench_heapdumphistory">
<description>A list of recently opened snapshots.</description>
<topic href="reference/workbench.html#ref_workbench__heapdumphistory" label="Heap Dump History"/>
</context>
<context id="workbench_heapdumpdetails">
<description>Summary of information about a snapshot.</description>
<topic href="reference/workbench.html#ref_workbench__heapdumpdetails" label="Heap Dump Details"/>
</context>
<context id="workbench_inspector">
<description>This shows details about an individual Java object which has been selected in the main heap editor window.</description>
<topic href="reference/workbench.html#ref_workbench__inspector" label="Inspector View"/>
</context>
<context id="workbench_notes">
<description>Notes View for user entered text describing the snapshot.</description>
<topic href="reference/workbench.html#ref_workbench__notes" label="Notes View"/>
</context>
<context id="workbench_navigationhistory">
<description>This shows the queries which have been recently been performed on the snapshot.</description>
<topic href="reference/workbench.html#ref_workbench__navigationhistory" label="Navigation History"/>
</context>
<context id="workbench_comparebasket">
<description>A container of query results of trees or tables which can then be compared.</description>
<topic href="reference/workbench.html#ref_workbench__comparebasket" label="Compare Basket View"/>
</context>
</contexts>
14 changes: 9 additions & 5 deletions plugins/org.eclipse.mat.ui.help/reference/tipsandtricks.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
</ul>
</stentry>
</strow>
<strow>
<strow id="notes_hyperlink">
<stentry>Notes, Hyperlinks in Notes View</stentry>
<stentry>
Notes View recognizes and highlights object addresses. Activating
Expand All @@ -152,18 +152,22 @@
<image href="../mimes/1af34c1.png" align="left" placement="break" />
</stentry>
</strow>
<strow>
<strow id="history">
<stentry> Manage the history of opened heap dumps</stentry>
<stentry>
Heap Dump History view offers a set of context menu actions to
manage the history of opened heap dumps:
<image href="../mimes/691a2594.png" align="left" placement="break" />
<p>
<uicontrol>Delete Heap Dump</uicontrol>>
<uicontrol>Delete Heap Dump</uicontrol>
action removes the heap dump from the history, but not from the
file system. To find a heap dump in the file system use
<uicontrol>Explore in File System</uicontrol>>
context menu action
<uicontrol>Explore in File System</uicontrol>
context menu action.
<uicontrol>Delete Index Files</uicontrol> deletes the index files
for a snapshot. The heap dump will be reparsed if reopened.
This command could be useful to save disk space, or
to reparse the heap dump with new options.
</p>
</stentry>
</strow>
Expand Down
90 changes: 47 additions & 43 deletions plugins/org.eclipse.mat.ui.help/reference/tipsandtricks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>
</p>

<table cellpadding="4" cellspacing="0" summary="" id="ref_tips__tips_table" border="1" class="simpletable"><col style="width:20%" /><col style="width:80%" /><thead><tr class="sthead">
<th style="vertical-align:bottom;text-align:left;" id="d8327e37" class="stentry">Tip</th>
<th style="vertical-align:bottom;text-align:left;" id="d9006e37" class="stentry">Tip</th>

<th style="vertical-align:bottom;text-align:left;" id="d8327e40" class="stentry">Description</th>
<th style="vertical-align:bottom;text-align:left;" id="d9006e40" class="stentry">Description</th>

</tr>
</thead><tbody><tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Shortcuts. Use <span class="ph uicontrol">command</span> instead of <span class="ph uicontrol">ctrl</span> on macOS</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Shortcuts. Use <span class="ph uicontrol">command</span> instead of <span class="ph uicontrol">ctrl</span> on macOS</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
<p class="p"><span class="ph uicontrol">ctrl+Q</span> - Opens the Query Browser.</p>

<p class="p"><span class="ph uicontrol">ctrl+H</span> - Opens the history of executed queries.</p>
Expand All @@ -63,9 +63,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Quick Search</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Quick Search</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
Just start to type while you are in the heap editor, all the
matches will be highlighted. This quick search starts is activated
when 3 or more letters are provided.
Expand All @@ -74,9 +74,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Filter</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Filter</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
To show only rows of a table or tree matching a filter,
click the top row, or press enter when the top row is selected.
Then type the required filter for the column. Multiple filters can be used.
Expand Down Expand Up @@ -121,9 +121,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Resize and reorder columns</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Resize and reorder columns</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
To resize or rearrange columns using the keyboard select a filter entry
for the column as above.
<ul class="ul">
Expand All @@ -141,9 +141,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Keyboard navigation of trees</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Keyboard navigation of trees</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
<ul class="ul">
<li class="li">Use <span class="ph uicontrol">numpad-plus</span> or <span class="ph uicontrol">enter</span> to expand a row.</li>

Expand All @@ -160,10 +160,10 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>
</td>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Notes, Hyperlinks in Notes View</td>
<tr id="ref_tips__notes_hyperlink" class="strow">
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Notes, Hyperlinks in Notes View</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
Notes View recognizes and highlights object addresses. Activating
the hyperlink brings up a context menu which contains actions for
this particular object. Activate the hyperlink using the <span class="ph uicontrol">control</span> key
Expand All @@ -173,47 +173,51 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Undo/redo in Notes View, OQL Pane</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Undo/redo in Notes View, OQL Pane</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
There is undo/redo using <span class="ph uicontrol">ctrl+Z</span> / <span class="ph uicontrol">ctrl+Y</span> in the Notes View and
the OQL Pane. The navigator pane can also be used to retrieve
previous OQL statements.
</td>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Copy To Clipboard</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Copy To Clipboard</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
Use <span class="ph uicontrol">ctrl+C</span> to copy the selection to the clipboard. The data will
keep its structure:
<br /><div class="imageleft"><img class="image imageleft" src="../mimes/1af34c1.png" /></div><br />
</td>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry"> Manage the history of opened heap dumps</td>
<tr id="ref_tips__history" class="strow">
<td style="vertical-align:top;" headers="d9006e37" class="stentry"> Manage the history of opened heap dumps</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
Heap Dump History view offers a set of context menu actions to
manage the history of opened heap dumps:
<br /><div class="imageleft"><img class="image imageleft" src="../mimes/691a2594.png" /></div><br />
<p class="p">
<span class="ph uicontrol">Delete Heap Dump</span>&gt;
<span class="ph uicontrol">Delete Heap Dump</span>
action removes the heap dump from the history, but not from the
file system. To find a heap dump in the file system use
<span class="ph uicontrol">Explore in File System</span>&gt;
context menu action
<span class="ph uicontrol">Explore in File System</span>
context menu action.
<span class="ph uicontrol">Delete Index Files</span> deletes the index files
for a snapshot. The heap dump will be reparsed if reopened.
This command could be useful to save disk space, or
to reparse the heap dump with new options.
</p>

</td>

</tr>
<tr id="ref_tips__editor_tabs" class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Manage editor tabs</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Manage editor tabs</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
Right click on the Heap Editor tab will open a context menu to
manage the tabs. It might be very helpful when many tabs are open.
<br /><div class="imageleft"><img class="image imageleft" src="../mimes/7df38219.png" /></div><br />
Expand Down Expand Up @@ -269,9 +273,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry"> Link Inspector View with Heap Editor</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry"> Link Inspector View with Heap Editor</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
Object Inspector View shows the details for the single selected
object. The view updates itself with every change in the
selection. Sometimes it is interesting to compare two or more
Expand All @@ -285,9 +289,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr id="ref_tips__attribute_tab" class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Attribute tab in Inspector View</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Attribute tab in Inspector View</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
The Object Inspector View shows the details for the single selected
object. The attribute tab shows the fields of an object or array elements
for an array.
Expand Down Expand Up @@ -345,9 +349,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr id="ref_tips__value_tab" class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Value tab in Inspector View</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Value tab in Inspector View</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
The Object Inspector View shows the details for the single selected
object. The value tab shows the value as given by the
<a class="xref" href="../doc/org_eclipse_mat_api_nameResolver.html">
Expand All @@ -357,9 +361,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Image and Color objects</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Image and Color objects</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
The Object Inspector View
recreates Eclipse colors and images from the information in the heap dump and
displays the information in the lower left corner of the inspector.
Expand All @@ -372,19 +376,19 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Class Hierarchy in Inspector</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Class Hierarchy in Inspector</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
The inspector now displays the full class hierarchy of any selected object.
One can drill-down via context menus.
<br /><div class="imageleft"><img class="image imageleft" src="../mimes/nn_inspector_class_hierarchy.png" /></div><br />
</td>

</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Context menu for totals row</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Context menu for totals row</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
The totals row now represents all the additional entries in a tree or table.
If the totals row is selected then the context menu will operate on all the unshown
entries in the tree or table. If all the rows are selected, for example using <span class="ph uicontrol">ctrl+A</span>,
Expand All @@ -397,9 +401,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr class="strow">
<td style="vertical-align:top;" id="ref_tips__oqlcompletion" headers="d8327e37" class="stentry">OQL autocompletion</td>
<td style="vertical-align:top;" id="ref_tips__oqlcompletion" headers="d9006e37" class="stentry">OQL autocompletion</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
The Object Query Language (OQL) pane has syntax highlighting for OQL
keywords. It also offers suggestions for class names for the
<span class="keyword">SELECT</span> <span class="keyword">FROM</span> clause, both simple class names and regular expressions.
Expand Down Expand Up @@ -430,9 +434,9 @@ <h1 class="title topictitle1" id="ariaid-title1">Tips and Tricks</h1>

</tr>
<tr id="ref_tips__piechartlinks" class="strow">
<td style="vertical-align:top;" headers="d8327e37" class="stentry">Links in Pie Chart Image</td>
<td style="vertical-align:top;" headers="d9006e37" class="stentry">Links in Pie Chart Image</td>

<td style="vertical-align:top;" headers="d8327e40" class="stentry">
<td style="vertical-align:top;" headers="d9006e40" class="stentry">
Memory Analyzer 1.11 adds hot-spots to the pie chart.
The legend entries now link to the referenced object.
<br /><div class="imageleft"><img class="image imageleft" src="../mimes/piechartlinks.png" height="292" width="809" alt="Pie Chart showing links from legend" /></div><br />
Expand Down

0 comments on commit 0dff02f

Please sign in to comment.