aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2022-05-25 10:31:32 +0800
committerzeertzjq <zeertzjq@outlook.com>2022-05-26 07:47:00 +0800
commiteb623a1c45bab279e202b718f52543da92baaabd (patch)
tree7c22630c81f7dc0ab9313f63ae193db2c8100d74
parent6db3f3f62457ff99a763d912f42d6d66eea8b74a (diff)
downloadrneovim-eb623a1c45bab279e202b718f52543da92baaabd.tar.gz
rneovim-eb623a1c45bab279e202b718f52543da92baaabd.tar.bz2
rneovim-eb623a1c45bab279e202b718f52543da92baaabd.zip
docs: add missing termdebug docs from Vim runtime updates
https://github.com/vim/vim/commit/388a5d4f20b4b64341d1604aa238cab85827b892 https://github.com/vim/vim/commit/4466ad6baa22485abb1147aca3340cced4778a66 https://github.com/vim/vim/commit/6aa57295cfbe8f21c15f0671e45fd53cf990d404 Rename terminal.txt to nvim_terminal_emulator.txt in vim-patch.sh.
-rw-r--r--runtime/doc/nvim_terminal_emulator.txt34
-rwxr-xr-xscripts/vim-patch.sh4
2 files changed, 24 insertions, 14 deletions
diff --git a/runtime/doc/nvim_terminal_emulator.txt b/runtime/doc/nvim_terminal_emulator.txt
index 49e29111c6..253053e1b8 100644
--- a/runtime/doc/nvim_terminal_emulator.txt
+++ b/runtime/doc/nvim_terminal_emulator.txt
@@ -304,7 +304,7 @@ breakpoint, or use the "Clear breakpoint" right-click menu entry.
Inspecting variables ~
*termdebug-variables* *:Evaluate*
`:Evaluate` evaluate the expression under the cursor
- `K` same
+ `K` same (see |termdebug_map_K| to disable)
`:Evaluate` {expr} evaluate {expr}
`:'<,'>Evaluate` evaluate the Visually selected text
@@ -363,6 +363,10 @@ This works slightly differently:
*termdebug_use_prompt*
Prompt mode can be used with: >
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_map_K = 0
<
*termdebug_disasm_window*
@@ -387,11 +391,11 @@ communication channel.
Customizing ~
-GDB command *termdebug-customizing*
-
-To change the name of the gdb command, set the "termdebugger" variable before
+GDB command *termdebug-customizing*
+ *g:termdebugger*
+To change the name of the gdb command, set the "g:termdebugger" variable before
invoking `:Termdebug`: >
- let termdebugger = "mygdb"
+ let g:termdebugger = "mygdb"
If the command needs an argument use a List: >
let g:termdebugger = ['rr', 'replay', '--']
@@ -439,16 +443,18 @@ The argument is the gdb command.
Vim window width *termdebug_wide*
-To change the width of the Vim window when debugging starts, and use a
-vertical split: >
- 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 larger than
-g:termdebug_wide then a vertical split will be used without changing &columns.
-Set it to 1 to get a vertical split without every changing &columns (useful
-for when the terminal can't be resized by Vim).
+To change the width of the Vim window when debugging starts and use a vertical
+split: >
+ 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
+vertical split will be used without modifying 'columns'.
+Set g:termdebug_wide to 1 to use a vertical split without ever changing
+'columns'. This is useful when the terminal can't be resized by Vim.
vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/scripts/vim-patch.sh b/scripts/vim-patch.sh
index e7e8f0b274..8235949156 100755
--- a/scripts/vim-patch.sh
+++ b/scripts/vim-patch.sh
@@ -243,6 +243,10 @@ preprocess_patch() {
LC_ALL=C sed -e 's/\( [ab]\/src\/nvim\)\/keymap\.h/\1\/keycodes.h/g' \
"$file" > "$file".tmp && mv "$file".tmp "$file"
+ # Rename terminal.txt to nvim_terminal_emulator.txt
+ LC_ALL=C sed -e 's/\( [ab]\/runtime\/doc\)\/terminal\.txt/\1\/nvim_terminal_emulator.txt/g' \
+ "$file" > "$file".tmp && mv "$file".tmp "$file"
+
# Rename test_urls.vim to check_urls.vim
LC_ALL=C sed -e 's@\( [ab]\)/runtime/doc/test\(_urls\.vim\)@\1/scripts/check\2@g' \
"$file" > "$file".tmp && mv "$file".tmp "$file"