summaryrefslogtreecommitdiffstats
path: root/doc/vim-go.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/vim-go.txt')
-rw-r--r--doc/vim-go.txt49
1 files changed, 47 insertions, 2 deletions
diff --git a/doc/vim-go.txt b/doc/vim-go.txt
index cc412836..d33a8b38 100644
--- a/doc/vim-go.txt
+++ b/doc/vim-go.txt
@@ -1498,9 +1498,9 @@ other packages. Valid options are `gopls` and `guru`. By default it's `gopls`.
Use this option to define the command to be used for |:GoImplements|.
The Implements feature in gopls is still new and being worked upon.
-Valid options are `gopls` and `guru`. By default it's `guru`.
+Valid options are `gopls` and `guru`. By default it's `gopls`.
>
- let g:go_implements_mode = 'guru'
+ let g:go_implements_mode = 'gopls'
<
*'g:go_def_mapping_enabled'*
@@ -2490,7 +2490,52 @@ Show only variables on the right-hand side: >
let g:go_debug_windows = {
\ 'vars': 'rightbelow 60vnew',
\ }
+
+ *'g:go_debug_mappings'*
+
+Contains custom key mapping information to customize the active mappings
+when debugging.
+
+Only the customizations desired need to be provided; the debugger will use its
+default key mappings for any mapping not defined here.
+
+This value should be a dictionary whose keys are the plugin mapping commands
+(e.g. `(go-debug-continue)`). The values are dictionaries with two keys.
+`key` and `attributes`.
+
+`key` is expected to be the key to map (i.e. it's the `lhs` in a mapping).
+`key` can be empty or missing to prevent a key mapping from being applied for
+one the named mappings.
+
+`arguments` is the string of `map-arguments` for the mapping (e.g.
+`<nowait>`).
+
+The first item must be the `lhs` to use for the mapping. The optional
+second item is for `:map-arguments`. All mappings will always be `:map-local`,
+so there is never a need to include `"<buffer>"` in the the arguments.
+>
+ let g:go_debug_mappings = {
+ \ '(go-debug-continue)': {'key': 'c', 'arguments': '<nowait>'],
+ \ '(go-debug-stop)': {'key': 'q'},
+ \ '(go-debug-next)': {'key': 'n', 'arguments': '<nowait>'},
+ \ '(go-debug-step)': {'key': 's'},
+ \}
<
+
+Defaults are equivalent to:
+>
+ let g:go_debug_mappings = {
+ \ '(go-debug-continue)': {'key': '<F5>'},
+ \ '(go-debug-print)': {'key': '<F6>'},
+ \ '(go-debug-breakpoint)': {'key': '<F9>'},
+ \ '(go-debug-next)': {'key': '<F10>'},
+ \ '(go-debug-step)': {'key': '<F11>'},
+ \ '(go-debug-halt)': {'key': '<F8>'},
+ \ }
+<
+
+Your user specified settings will be merged with the defaults.
+
*'g:go_debug_address'*
Server address `dlv` will listen on; must be in `hostname:port` format.