From bb0ba16ab0c15f3e19ede8e4fb48c9b525c7f8cb Mon Sep 17 00:00:00 2001
From: Dan <46821332+nsadeveloper789@users.noreply.github.com>
Date: Mon, 4 Dec 2023 16:04:47 -0500
Subject: [PATCH] GP-4101: Update Debugger help
---
Ghidra/Debug/Debugger/certification.manifest | 3 +-
.../src/main/help/help/TOC_Source.xml | 4 -
.../topics/DebuggerBots/DebuggerBots.html | 73 --------
.../DebuggerBreakpointMarkerPlugin.html | 18 ++
.../images/DebuggerBreakpointMarkerPlugin.png | Bin 64900 -> 74274 bytes
.../DebuggerDecompilerBreakpointMargin.png | Bin 28636 -> 26017 bytes
.../DebuggerFunctionGraphBreakpointMargin.png | Bin 0 -> 54692 bytes
.../images/DebuggerPlaceBreakpointDialog.png | Bin 8594 -> 7159 bytes
.../DebuggerConsolePlugin.html | 12 +-
.../DebuggerControlPlugin.html | 2 +-
.../DebuggerListingPlugin.html | 10 ++
.../DebuggerModulesPlugin.html | 31 ++--
.../DebuggerModuleMapProposalDialog.png | Bin 15353 -> 13786 bytes
.../images/DebuggerModulesPlugin.png | Bin 29553 -> 27341 bytes
.../DebuggerSectionMapProposalDialog.png | Bin 22117 -> 19797 bytes
.../DebuggerRegionsPlugin.html | 13 +-
.../DebuggerStaticMappingPlugin.html | 13 +-
.../gui/console/DebuggerConsoleProvider.java | 2 +
...ggerBreakpointMarkerPluginScreenShots.java | 164 ++++++++++++++++++
19 files changed, 229 insertions(+), 116 deletions(-)
delete mode 100644 Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBots/DebuggerBots.html
create mode 100644 Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/images/DebuggerFunctionGraphBreakpointMargin.png
diff --git a/Ghidra/Debug/Debugger/certification.manifest b/Ghidra/Debug/Debugger/certification.manifest
index 6210059af1..e813f80d23 100644
--- a/Ghidra/Debug/Debugger/certification.manifest
+++ b/Ghidra/Debug/Debugger/certification.manifest
@@ -11,10 +11,10 @@ src/main/help/help/TOC_Source.xml||GHIDRA||||END|
src/main/help/help/topics/Debugger/Debugger.html||GHIDRA||||END|
src/main/help/help/topics/Debugger/GettingStarted.html||GHIDRA||||END|
src/main/help/help/topics/Debugger/Troubleshooting.html||GHIDRA||||END|
-src/main/help/help/topics/DebuggerBots/DebuggerBots.html||GHIDRA||||END|
src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/DebuggerBreakpointMarkerPlugin.html||GHIDRA||||END|
src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/images/DebuggerBreakpointMarkerPlugin.png||GHIDRA||||END|
src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/images/DebuggerDecompilerBreakpointMargin.png||GHIDRA||||END|
+src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/images/DebuggerFunctionGraphBreakpointMargin.png||GHIDRA||||END|
src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/images/DebuggerPlaceBreakpointDialog.png||GHIDRA||||END|
src/main/help/help/topics/DebuggerBreakpointsPlugin/DebuggerBreakpointsPlugin.html||GHIDRA||||END|
src/main/help/help/topics/DebuggerBreakpointsPlugin/images/DebuggerBreakpointsPlugin.png||GHIDRA||||END|
@@ -141,7 +141,6 @@ src/main/resources/images/stepover.png||GHIDRA||||END|
src/main/resources/images/system-switch-user.png||Oxygen Icons - LGPL 3.0|||Oxygen icon theme (dual license; LGPL or CC-SA-3.0)|END|
src/main/resources/images/thread.png||GHIDRA||||END|
src/main/resources/images/time.png||FAMFAMFAM Icons - CC 2.5||||END|
-src/main/resources/images/write-disabled.png||GHIDRA||||END|
src/main/resources/images/write-emulator.png||GHIDRA||||END|
src/main/resources/images/write-target.png||GHIDRA||||END|
src/main/resources/images/write-trace.png||Tango Icons - Public Domain||||END|
diff --git a/Ghidra/Debug/Debugger/src/main/help/help/TOC_Source.xml b/Ghidra/Debug/Debugger/src/main/help/help/TOC_Source.xml
index 1045bbc448..0e27f90481 100644
--- a/Ghidra/Debug/Debugger/src/main/help/help/TOC_Source.xml
+++ b/Ghidra/Debug/Debugger/src/main/help/help/TOC_Source.xml
@@ -176,10 +176,6 @@
Bots are a pluggable part of the Debugger's Workflow plugin and provide useful automation, - taking actions on the user's behalf that would otherwise be tedious, or that should occur - "under the hood." Each can be toggled from the
- - menu in Ghidra's Project window.This bot automatically displays the interpreter console for new debugger connections. If a - connection does not present an interpreter, then this bot will take no action. This action can - be performed manually using the Console action in - the Commands and Objects window.
- -This bot automatically disassembles trace memory, starting at the program counter. It is - activated whenever an open trace's memory or program counters change. If the target presents a - stack, then the bot will prefer to use the program counter recorded in the innermost frame 0. - Otherwise, it will use the value of the program counter register. To accommodate multi-threaded - traces, the bot considers all threads when responding to memory changes. It considers only the - affected thread for program counter changes. This action can be performed manually using the Disassemble command in - the Dynamic Listing window.
- -This bot automatically maps trace modules to programs opened in the same tool. It is - activated whenever a trace or program is opened, or when an opened trace's modules change. For - a given trace, this bot considers only those modules not already mapped, seeking suitable - programs open in the same tool. If the trace is open in multiple tools (not common) the bot - will consider programs from all such tools where the workflow plugin is enabled. This action - can be performed manually using the Map Modules - action in the Modules and Sections window.
- -This bot automatically maps trace sections to memory blocks of programs opened in the same - tool. Its operation is analogous to that of the Map Modules Bot, except that it creates the - mapped ranges by section. It is not commonly used, as it's less efficient than the Map Modules - Bot, but it is required whenever a target presents sections which can be relocated - independently of other sections in the same module. This is more common in abstract machines, - such as the Java Virtual Machine, where each method is a "section." This action can be - performed manually using the Map Sections - action in the Modules and Sections window.
- -This bot automatically maps trace regions to memory blocks of programs opened in the same - tool. Its operation is analogous to that of the Map Modules Bot, except that it creates the - mapped ranges by region. It is not commonly used, as it's less efficient than the Map Modules - Bot, but it is required whenever a target fails to present modules. This action can be - performed manually using the Map Regions - action in the Regions window.
- - diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/DebuggerBreakpointMarkerPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/DebuggerBreakpointMarkerPlugin.html index 43e4936bc2..e23b219d47 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/DebuggerBreakpointMarkerPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/DebuggerBreakpointMarkerPlugin.html @@ -35,6 +35,24 @@By default, enabled breakpoints are colored a desaturated blue, ineffective breakpoints are colored grey, and disabled breakpoints have no background at all.
++ |
When active in the Debugger, the Function Graph will display + breakpoints using background colors and markers in each vertex's margin. The margin behaves + exactly as it would in the static listing. A marker is displayed at each address with a + breakpoint indicating its state. Multiple breakpoints at an address may result in display of a + mixed state. Double clicking in the margin will set or toggle a breakpoint at that address.
+