Skip to content

Ghidra is a software reverse engineering (SRE) framework

Fixed missing graph help

dragonmacherc94d44fe1da8
diff --git a/Ghidra/Features/Base/src/main/help/help/TOC_Source.xml b/Ghidra/Features/Base/src/main/help/help/TOC_Source.xml
index 822cdadb25..b7d1d90c6d 100644
--- a/Ghidra/Features/Base/src/main/help/help/TOC_Source.xml
+++ b/Ghidra/Features/Base/src/main/help/help/TOC_Source.xml
@@ -157,8 +157,9 @@
<tocdef id="FileSystem Browser" text="FileSystem Browser" target="help/topics/FileSystemBrowserPlugin/FileSystemBrowserPlugin.html" />
- <tocdef id="Graphing" text="Graphing" target="help/topics/Graph/GraphIntro.html">
- <tocdef id="Graph Services" text="Graph Services" target="help/topics/Graph/GraphServicesIntro.html"/>
+ <tocdef id="Graphing" text="Graphing" target="help/topics/Graph/GraphIntro.html">
+ <tocdef id="Graph Services" sortgroup="a" text="Graph Services" target="help/topics/Graph/GraphServicesIntro.html"/>
+ <tocdef id="Visual Graphs" text="Visual Graphs" target="help/topics/VisualGraph/Visual_Graph.html"/>
</tocdef>
<tocdef id="Program Tree" text="Program Tree" target="help/topics/ProgramTreePlugin/program_tree.htm" >
diff --git a/Ghidra/Features/ProgramGraph/src/main/help/help/TOC_Source.xml b/Ghidra/Features/ProgramGraph/src/main/help/help/TOC_Source.xml
index 7c0e646201..344242b0f7 100644
--- a/Ghidra/Features/ProgramGraph/src/main/help/help/TOC_Source.xml
+++ b/Ghidra/Features/ProgramGraph/src/main/help/help/TOC_Source.xml
@@ -51,7 +51,7 @@
<tocroot>
<tocref id="Graphing">
- <tocdef id="Graphing the Program" text="Graphing the Program" target="help/topics/ProgramGraphPlugin/ProgramGraph.htm" />
+ <tocdef id="Program Graph" text="Program Graph" target="help/topics/ProgramGraphPlugin/ProgramGraph.htm" />
</tocref>
</tocroot>
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/help/HelpManager.java b/Ghidra/Framework/Docking/src/main/java/docking/help/HelpManager.java
index 86898f8bc8..99e3100b7c 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/help/HelpManager.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/help/HelpManager.java
@@ -523,20 +523,28 @@ public class HelpManager implements HelpService {
public Map<Object, HelpLocation> getInvalidHelpLocations(TaskMonitor monitor)
throws CancelledException {
+ Set<String> alreadySeen = new HashSet<>();
Map<Object, HelpLocation> map = new WeakHashMap<>();
Map<Object, HelpLocation> helpLocationsCopy = copyHelpLocations();
monitor.initialize(helpLocationsCopy.size());
Set<Entry<Object, HelpLocation>> entries = helpLocationsCopy.entrySet();
for (Entry<Object, HelpLocation> entry : entries) {
- monitor.checkCancelled();
+ monitor.increment();
Object helpee = entry.getKey();
HelpLocation location = entry.getValue();
monitor.setMessage("Checking " + helpee);
- if (!hasValidHelp(helpee, location)) {
- map.put(helpee, location);
+ if (hasValidHelp(helpee, location)) {
+ continue;
}
- monitor.incrementProgress(1);
+
+ String inception = location.getInceptionInformation();
+ if (alreadySeen.contains(inception)) {
+ continue; // don't show repeated errors for same line of code
+ }
+
+ alreadySeen.add(inception);
+ map.put(helpee, location);
}
return map;
}
diff --git a/Ghidra/Framework/Graph/src/main/help/help/topics/VisualGraph/Visual_Graph.html b/Ghidra/Framework/Graph/src/main/help/help/topics/VisualGraph/Visual_Graph.html
index c2356bba25..1f570aa250 100644
--- a/Ghidra/Framework/Graph/src/main/help/help/topics/VisualGraph/Visual_Graph.html
+++ b/Ghidra/Framework/Graph/src/main/help/help/topics/VisualGraph/Visual_Graph.html
@@ -2,9 +2,6 @@
<HTML>
<HEAD>
- <META name="generator" content=
- "HTML Tidy for Java (vers. 2009-12-01), see jtidy.sourceforge.net">
-
<TITLE>Visual Graphs</TITLE>
<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
<LINK rel="stylesheet" type="text/css" href="help/shared/DefaultStyle.css">
@@ -15,7 +12,8 @@
<BLOCKQUOTE>
<P>Visual Graphs are highly integrated graphs that all share common features and
- actions. They typically have both a <A href="#Visual_Graph_Primary_View">Primary View</A> and
+ actions. Various Graph component providers are based upon the Visual Graph API.They typically
+ have both a <A href="#Visual_Graph_Primary_View">Primary View</A> and
a <A href="#Satellite_View">Satellite View</A>
</BLOCKQUOTE>
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/featurette/VgSatelliteFeaturette.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/featurette/VgSatelliteFeaturette.java
index 3af7078d4b..31cac30c53 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/featurette/VgSatelliteFeaturette.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/featurette/VgSatelliteFeaturette.java
@@ -288,9 +288,7 @@ public class VgSatelliteFeaturette<V extends VisualVertex,
satelliteComponent.setMinimumSize(new Dimension(400, 400));
- // TODO - need generic, shared help for the common abstract graph features;
- // will be done in an upcoming ticket
- // setHelpLocation(new HelpLocation("Graph", "Satellite_View_Dock"));
+ setHelpLocation(new HelpLocation("VisualGraph", "Satellite_View_Dock"));
// this will group the satellite with the provider
setWindowMenuGroup(windowGroup);
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/GraphComponent.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/GraphComponent.java
index 8673ab7747..9eabed8402 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/GraphComponent.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/GraphComponent.java
@@ -473,7 +473,7 @@ public class GraphComponent<V extends VisualVertex, E extends VisualEdge<V>, G e
HelpService helpService = DockingWindowManager.getHelpService();
helpService.registerHelp(button,
- new HelpLocation("Visual_Graph", "Satellite_View_Dock"));
+ new HelpLocation("VisualGraph", "Satellite_View_Dock"));
return button;
}