Add docs for the new debugger info widget

1ikeadragon · Nov 1, 2024 · 4e31c71 · 4e31c71
1 parent cc50d62
commit 4e31c71
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/docs/guide/index.md b/docs/guide/index.md
@@ -162,6 +162,28 @@ Note: on macOS 13, the size of system dylib are calculated wrong. The bizarrely
 The size of the main executable is still calculated correctly.
 
 
+#### Debugger Info Widget
+
+The debugger info widget shows the relevant information of the current (or selected) instruction. It shows the value of
+registers, memory read/writes, as long as any hints if the value can be dereferenced. The goal is to provide more
+context for the target and offer the relevant information directly.
+
+![](../../img/debugger/debuggerinfo0.png)
+
+If the selected instruction is a function call, the call parameters are listed:
+
+![](../../img/debugger/debuggerinfo1.png)
+
+If the selected instruction is a conditional branch, the values being compared are listed and the result (token or not
+taken) are predicted:
+
+![](../../img/debugger/debuggerinfo2.png)
+
+Please be aware that the widget always uses the target's current status (registers, memory) to calculate the value of
+the requested expressions. If you select an instruction different from the active one, the value could be wrong even if
+it could be calculated.
+
+
 ### Debugger Status Widget
 
 ![](../../img/debugger/statuswidget.png)

diff --git a/docs/img/debugger/debuggerinfo0.png b/docs/img/debugger/debuggerinfo0.png
diff --git a/docs/img/debugger/debuggerinfo1.png b/docs/img/debugger/debuggerinfo1.png
diff --git a/docs/img/debugger/debuggerinfo2.png b/docs/img/debugger/debuggerinfo2.png