From e925574dc08408f3f198700e91a0a9585fc01cf9 Mon Sep 17 00:00:00 2001 From: Dan <46821332+nsadeveloper789@users.noreply.github.com> Date: Fri, 21 Apr 2023 16:34:17 -0400 Subject: [PATCH] GP-3218: Remove 'Tool Options: Colors' sections from Debugger help --- .../DebuggerBreakpointMarkerPlugin.html | 10 +++---- .../DebuggerListingPlugin.html | 4 --- .../DebuggerMemoryBytesPlugin.html | 5 ---- .../DebuggerRegistersPlugin.html | 27 +++++++++---------- .../DebuggerTraceViewDiffPlugin.html | 5 ---- .../DebuggerWatchesPlugin.html | 27 +++++++++---------- 6 files changed, 27 insertions(+), 51 deletions(-) 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 93887c6913..43e4936bc2 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 @@ -32,6 +32,9 @@ the current target. NOTE: Depending on the connected debugger, locations resulting from a common specification may not be independently manipulated.

+

By default, enabled breakpoints are colored a desaturated blue, ineffective breakpoints are + colored grey, and disabled breakpoints have no background at all.

+

In the Decompiler

@@ -132,12 +135,5 @@

This action is available when there is at least one breakpoint (in any state) at the cursor. It deletes those logical breakpoints.

- -

Tool Options: Colors

- -

The background coloring of enabled and disabled, effective and ineffective breakpoints can - be configured in the tool's options. By default, enabled breakpoints are colored a desaturated - blue, ineffective breakpoints are colored grey, and disabled breakpoints have no background at - all.

diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerListingPlugin/DebuggerListingPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerListingPlugin/DebuggerListingPlugin.html index 3fa2c7bdd5..25d3b0d1f4 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerListingPlugin/DebuggerListingPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerListingPlugin/DebuggerListingPlugin.html @@ -246,9 +246,5 @@
  • Read Visible Memory, RO Once - (default) behaves like Read Visible Memory, except it will neglect read-only ranges that have been read previously.
    • - -

    Tool Options: Colors

    - -

    The memory-state and tracked-location background colors can all be configured here.

    diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerMemoryBytesPlugin/DebuggerMemoryBytesPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerMemoryBytesPlugin/DebuggerMemoryBytesPlugin.html index 94d5029bf5..fc78637adb 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerMemoryBytesPlugin/DebuggerMemoryBytesPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerMemoryBytesPlugin/DebuggerMemoryBytesPlugin.html @@ -129,10 +129,5 @@ trace's editing mode is set to Read-Only in the tool. NOTE: This toggle also disables automatic navigation in order to prevent the cursor from being moved unexpectedly while typing edits.

    - -

    Tool Options: Colors

    - -

    The memory-state and tracked-location background colors are replicated from the Dynamic Listing.

    diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerRegistersPlugin/DebuggerRegistersPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerRegistersPlugin/DebuggerRegistersPlugin.html index 9cb24ebb86..e7fb0b76b9 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerRegistersPlugin/DebuggerRegistersPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerRegistersPlugin/DebuggerRegistersPlugin.html @@ -28,6 +28,18 @@ for the target processor. It permits for the selection, organization, display, search, modification, and analysis of the registers and values.

    +

    The register window uses colors to hint about the state of registers and their values. By + default, changed registers are displayed in red, and stale registers are displayed in dark + grey. A "stale" register is one whose current value is not known. The value displayed is the + last recorded value or the default value 0. Simply, a "changed" register is one whose value has + just changed. For example, if a register is modified as result of stepping, then that register + is changed. However, given the possibility of rewinding, changing thread focus, etc., "changed" + is actually subtly more flexible. The registers window remembers the user's last coordinates + (time, thread, frame, etc.) as well as the current coordinates. So, "changed" more precisely + refers to a register whose value differs between those two coordinates. This permits the user + to switch focus between different coordinates and quickly identify what is different, so long + as those coordinates pertain to the same processor language.

    +

    Table Columns

    The table displays information about registers, including their values and types. It has the @@ -109,20 +121,5 @@

    This button is analogous to the "snapshot" action of other Ghidra windows. It generates a clone of this window. The clone will no longer follow the current thread, but it will follow the current time.

    - -

    Tool Options: Colors

    - -

    The register window uses colors to hint about the state of registers and their values. They - can be configured in the tool's options. By default, changed registers are displayed in red, - and stale registers are displayed in dark grey. A "stale" register is one whose current value - is not known. The value displayed is the last recorded value or the default value 0. Simply, a - "changed" register is one whose value has just changed. For example, if a register is modified - as result of stepping, then that register is changed. However, given the possibility of - rewinding, changing thread focus, etc., "changed" is actually subtly more flexible. The - registers window remembers the user's last coordinates (time, thread, frame, etc.) as well as - the current coordinates. So, "changed" more precisely refers to a register whose value differs - between those two coordinates. This permits the user to switch focus between different - coordinates and quickly identify what is different, so long as those coordinates pertain to the - same processor language.

    diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTraceViewDiffPlugin/DebuggerTraceViewDiffPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTraceViewDiffPlugin/DebuggerTraceViewDiffPlugin.html index a8e988312f..9d144e8a98 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTraceViewDiffPlugin/DebuggerTraceViewDiffPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTraceViewDiffPlugin/DebuggerTraceViewDiffPlugin.html @@ -149,10 +149,5 @@

    These actions are only present when the comparison listing is visible. Each is available when there exists a previous or next range from the main listing's cursor. Clicking the action navigates to the nearest address in that range.

    - -

    Tool Options: Colors

    - -

    The difference highlight color is replicated from the Program Differences plugin.

    diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerWatchesPlugin/DebuggerWatchesPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerWatchesPlugin/DebuggerWatchesPlugin.html index 6ad0c355f7..7f9ba9d295 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerWatchesPlugin/DebuggerWatchesPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerWatchesPlugin/DebuggerWatchesPlugin.html @@ -30,6 +30,18 @@ applicable, that data type can optionally be applied to the trace database. Some metadata about the watch is also given, e.g., the address of the value.

    +

    The watch window uses colors to hint about changes in and freshness of displayed values. By + default, changed values are displayed in red, and stale values are displayed in dark grey. A + "stale" value is one which depends on any register or memory whose contents are not known. The + value displayed is that computed from the last recorded contents, defaulting to 0 when never + recorded. Simply, a "changed" watch is one whose value has just changed. For example, if a + value changes as result of stepping, then that watch is changed. However, given the possibility + of rewinding, changing thread focus, etc., "changed" is actually subtly more flexible. The + watch remembers the evaluation from the user's last coordinates (time, thread, frame, etc.) as + well as the current coordinates. So, "changed" more precisely refers to a watch whose value + differs between those two coordinates. This permits the user to switch focus between different + coordinates and quickly identify what is different.

    +

    Examples

    For those less familiar with Sleigh, here are some example expressions:

    @@ -162,20 +174,5 @@ "help/topics/DebuggerControlPlugin/DebuggerControlPlugin.html">Control and Machine State Plugin. Note: Only the raw "Value" column can be edited directly. The "Repr" column cannot be edited, yet.

    - -

    Tool Options: Colors

    - -

    The watch window uses colors to hint about changes in and freshness of displayed values. - They can be configured in the tool's options. By default, changed values are displayed in red, - and stale values are displayed in dark grey. A "stale" value is one which depends on any - register or memory whose contents are not known. The value displayed is that computed from the - last recorded contents, defaulting to 0 when never recorded. Simply, a "changed" watch is one - whose value has just changed. For example, if a value changes as result of stepping, then that - watch is changed. However, given the possibility of rewinding, changing thread focus, etc., - "changed" is actually subtly more flexible. The watch remembers the evaluation from the user's - last coordinates (time, thread, frame, etc.) as well as the current coordinates. So, "changed" - more precisely refers to a watch whose value differs between those two coordinates. This - permits the user to switch focus between different coordinates and quickly identify what is - different.