Skip to content

Commit a5de0b7

Browse files
committed
Merge remote-tracking branch 'origin/GP-0_Isabella3412_Help_file_cleanup--SQUASHED'
2 parents 86516b1 + 367f088 commit a5de0b7

File tree

7 files changed

+53
-9
lines changed

7 files changed

+53
-9
lines changed

Ghidra/Features/Base/src/main/help/help/topics/FunctionComparison/FunctionComparison.htm

+7-1
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,13 @@ <H4><A name="Compare_Matching_Callees"></A>Compare Matching Callees</H4>
494494

495495
<H4><A name="Dual_Decompiler_Toggle_Orientation"></A>Show Decompilers Side-by-Side</H4>
496496
<BLOCKQUOTE>
497-
<P>This toggles the decompiler panels between a vertical split and a horizontal split. </P>
497+
<P> This toggles the decompiler panels between a vertical split and a horizontal split. </P>
498+
</BLOCKQUOTE>
499+
500+
<H4><A name="Toggle_Exact_Constant_Matching"></A>Toggle Exact Constant Matching</H4>
501+
<BLOCKQUOTE>
502+
<P> This toggles whether or not constants must be exactly the same value to be a match in
503+
the Decompiler Diff View. </P>
498504
</BLOCKQUOTE>
499505
</BLOCKQUOTE>
500506

Ghidra/Features/CodeCompare/src/main/java/ghidra/codecompare/DecompilerDiffCodeComparisonPanel.java

+15-5
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,25 @@
2020
import javax.swing.Icon;
2121

2222
import docking.ActionContext;
23-
import docking.action.*;
24-
import docking.widgets.fieldpanel.internal.FieldPanelCoordinator;
23+
import docking.action.DockingAction;
24+
import docking.action.ToggleDockingAction;
25+
import docking.action.ToolBarData;
2526
import generic.theme.GIcon;
26-
import ghidra.app.decompiler.component.*;
27+
import ghidra.app.decompiler.component.DecompileData;
28+
import ghidra.app.decompiler.component.DecompilerCodeComparisonPanel;
29+
import ghidra.app.decompiler.component.DualDecompileResultsListener;
30+
import ghidra.app.decompiler.component.DualDecompilerActionContext;
2731
import ghidra.codecompare.graphanalysis.TokenBin;
2832
import ghidra.framework.options.OptionsChangeListener;
2933
import ghidra.framework.options.ToolOptions;
3034
import ghidra.framework.plugintool.PluginTool;
3135
import ghidra.util.HTMLUtilities;
36+
import ghidra.util.HelpLocation;
3237
import ghidra.util.exception.CancelledException;
33-
import ghidra.util.task.*;
38+
import ghidra.util.task.Task;
39+
import ghidra.util.task.TaskBuilder;
40+
import ghidra.util.task.TaskLauncher;
41+
import ghidra.util.task.TaskListener;
3442
import resources.Icons;
3543
import resources.MultiIcon;
3644

@@ -44,6 +52,7 @@ public class DecompilerDiffCodeComparisonPanel
4452
implements DualDecompileResultsListener, OptionsChangeListener {
4553

4654
public static final String CODE_DIFF_VIEW = "Decompiler Diff View";
55+
private static final String HELP_TOPIC = "FunctionComparison";
4756
private DecompileDataDiff decompileDataDiff;
4857
private DiffClangHighlightController leftHighlightController;
4958
private DiffClangHighlightController rightHighlightController;
@@ -199,7 +208,8 @@ public class MyToggleExactConstantMatching extends ToggleDockingAction {
199208
*/
200209
public MyToggleExactConstantMatching(String owner) {
201210
super("Toggle Exact Constant Matching", owner);
202-
211+
setHelpLocation(new HelpLocation(HELP_TOPIC, "Toggle Exact Constant Matching"));
212+
203213
this.setToolBarData(new ToolBarData(NO_EXACT_CONSTANT_MATCHING_ICON, "toggles"));
204214

205215
setDescription(HTMLUtilities.toHTML("Toggle whether or not constants must\n" +

Ghidra/Features/Decompiler/src/main/doc/decompileplugin.xml

+13
Original file line numberDiff line numberDiff line change
@@ -4939,6 +4939,19 @@
49394939
</para>
49404940
</sect2>
49414941

4942+
<sect2 id="ActionEditOverride">
4943+
<title>Edit Signature Override</title>
4944+
<para>
4945+
Edit the existing overriding function prototype to the called function under the cursor.
4946+
</para>
4947+
<para>
4948+
This action can only be triggered at call sites with an existing signature override. As with the Override
4949+
Signature command, users must select either the token representing the called function's name or the
4950+
tokens representing the function pointer at the call site. The action brings up a dialog where the user
4951+
can edit the current overriding function prototype.
4952+
</para>
4953+
</sect2>
4954+
49424955
<sect2 id="ActionReference">
49434956
<title>References</title>
49444957
<sect3 id="ActionFindUses">

Ghidra/Features/Decompiler/src/main/help/help/topics/DecompilePlugin/DecompilerWindow.html

+15
Original file line numberDiff line numberDiff line change
@@ -1111,6 +1111,21 @@
11111111
</p>
11121112
</div>
11131113

1114+
<div class="sect2">
1115+
<div class="titlepage"><div><div><h3 class="title">
1116+
<a name="ActionEditOverride"></a>Edit Signature Override</h3></div></div></div>
1117+
1118+
<p>
1119+
Edit the overriding function prototype applied previously to the called function under the cursor.
1120+
</p>
1121+
<p>
1122+
This action can only be triggered at call sites with an existing signature override. As with the Override
1123+
Signature command, users must select either the token representing the called function's name or the
1124+
tokens representing the function pointer at the call site. The action brings up a dialog where the user
1125+
can edit the current overriding function prototype.
1126+
</p>
1127+
</div>
1128+
11141129
<div class="sect2">
11151130
<div class="titlepage"><div><div><h3 class="title">
11161131
<a name="ActionReference"></a>References</h3></div></div></div>

Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/EditPrototypeOverrideAction.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public class EditPrototypeOverrideAction extends AbstractDecompilerAction {
3131

3232
public EditPrototypeOverrideAction() {
3333
super("Edit Signature Override");
34-
setHelpLocation(new HelpLocation(HelpTopics.DECOMPILER, "ActionEditOverride"));
34+
setHelpLocation(new HelpLocation(HelpTopics.DECOMPILER, "ActionEditOverride"));
3535
setPopupMenuData(new MenuData(new String[] { "Edit Signature Override" }, "Decompile"));
3636
}
3737

Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/OverridePrototypeAction.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
public class OverridePrototypeAction extends AbstractDecompilerAction {
3737

3838
public OverridePrototypeAction() {
39-
super("Override Signature");
39+
super("Override Signature");
4040
setHelpLocation(new HelpLocation(HelpTopics.DECOMPILER, "ActionOverrideSignature"));
4141
setPopupMenuData(new MenuData(new String[] { "Override Signature" }, "Decompile"));
4242
}

Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/gui/actions/OpenVersionTrackingSessionAction.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public OpenVersionTrackingSessionAction(VTController controller) {
3838
String[] menuPath = { ToolConstants.MENU_FILE, "Open Session..." };
3939
setMenuBarData(new MenuData(menuPath, "AAA"));
4040
setDescription("Opens a Version Tracking Session");
41-
setHelpLocation(new HelpLocation("VersionTrackingPlugin", "Open_Session"));
41+
setHelpLocation(new HelpLocation("VersionTrackingPlugin", "Version_Tracking_Tool"));
4242
}
4343

4444
@Override

0 commit comments

Comments
 (0)