patch 8.2.5010: the terminal debugger uses various global variables
Problem: The terminal debugger uses various global variables.
Solution: Add a dictionary to hold the terminal debugger preferences.
diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt
index 3d367bc..2c01c65 100644
--- a/runtime/doc/terminal.txt
+++ b/runtime/doc/terminal.txt
@@ -1367,7 +1367,7 @@
*TermdebugStartPre*
TermdebugStartPre Before starting debugging.
Not triggered if the debugger is already
- running or |g:termdebugger| cannot be
+ running or the debugger command cannot be
executed.
*TermdebugStartPost*
TermdebugStartPost After debugging has initialized.
@@ -1398,18 +1398,24 @@
*termdebug_use_prompt*
Prompt mode can be used even when the |+terminal| feature is present with: >
+ let g:termdebug_config['use_prompt'] = 1
+Or if there is no g:termdebug_config: >
let g:termdebug_use_prompt = 1
<
*termdebug_map_K*
The K key is normally mapped to :Evaluate. If you do not want this use: >
+ let g:termdebug_config['map_K'] = 0
+Or if there is no g:termdebug_config: >
let g:termdebug_map_K = 0
-
<
*termdebug_disasm_window*
-If you want the Asm window shown by default, set this to 1. Setting to
-any value greater than 1 will set the Asm window height to that value: >
+If you want the Asm window shown by default, set the flag to 1.
+the "disasm_window_height" entry can be used to set the window height: >
+ let g:termdebug_config['disasm_window'] = 1
+ let g:termdebug_config['disasm_window_height'] = 15
+or, if there is no g:termdebug_config: >
let g:termdebug_disasm_window = 15
-<
+Any value greater than 1 will set the Asm window height to that value: >
Communication ~
*termdebug-communication*
@@ -1426,15 +1432,36 @@
Customizing ~
+ *termdebug-customizing* *g:termdebug_config*
+In the past several global variables were used for configuration. These are
+deprecated, using the g:termdebug_config dictionary is preferred. When
+g:termdebug_config exists the other global variables will not be used.
-GDB command *termdebug-customizing*
+
+GDB command ~
*g:termdebugger*
-To change the name of the gdb command, set the "g:termdebugger" variable before
-invoking `:Termdebug`: >
+To change the name of the gdb command, set "debugger" entry in
+g:termdebug_config or the "g:termdebugger" variable before invoking
+`:Termdebug`: >
+ let g:termdebug_config['command'] = "mygdb"
+Or if there is no g:termdebug_config: >
let g:termdebugger = "mygdb"
+
If the command needs an argument use a List: >
+ let g:termdebug_config['command'] = ['rr', 'replay', '--']
+Or if there is no g:termdebug_config: >
let g:termdebugger = ['rr', 'replay', '--']
-< *gdb-version*
+
+Several arguments will be added to make gdb work well for the debugger.
+If you want to modify them, add a function to filter the argument list: >
+ let g:termdebug_config['command_filter'] = MyDebugFilter
+
+If you do not want the arguments to be added, but you do need to set the
+"pty", use a function to add the necessary arguments: >
+ let g:termdebug_config['command_add_args'] = MyAddArguments
+The function will be called with the list of arguments so far, and a second
+argument that is the name of the pty.
+ *gdb-version*
Only debuggers fully compatible with gdb will work. Vim uses the GDB/MI
interface. The "new-ui" command requires gdb version 7.12 or later. if you
get this error:
@@ -1442,8 +1469,8 @@
Then your gdb is too old.
-Colors *hl-debugPC* *hl-debugBreakpoint*
-
+Colors~
+ *hl-debugPC* *hl-debugBreakpoint*
The color of the signs can be adjusted with these highlight groups:
- debugPC the current position
- debugBreakpoint a breakpoint
@@ -1473,6 +1500,8 @@
Clear breakpoint `:Clear`
Evaluate `:Evaluate`
If you don't want this then disable it with: >
+ let g:termdebug_config['popup'] = 0
+or if there is no g:termdebug_config: >
let g:termdebug_popup = 0
@@ -1480,15 +1509,17 @@
To change the width of the Vim window when debugging starts and use a vertical
split: >
+ let g:termdebug_config['wide'] = 163
+Or if there is no g:termdebug_config: >
let g:termdebug_wide = 163
This will set 'columns' to 163 when `:Termdebug` is used. The value is
restored when quitting the debugger.
-If g:termdebug_wide is set and 'columns' is already a greater value, then a
+If the wide value is set and 'columns' is already a greater value, then a
vertical split will be used without modifying 'columns'.
-Set g:termdebug_wide to 1 to use a vertical split without ever changing
+Set the wide value to 1 to use a vertical split without ever changing
'columns'. This is useful when the terminal can't be resized by Vim.