aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike <Mike325@users.noreply.github.com>2023-02-27 14:19:41 -0600
committerGitHub <noreply@github.com>2023-02-27 21:19:41 +0100
commitf89e3497c88f59916e3bce2e902be9b0f8bf15ba (patch)
tree24b71875c13fe633f1db8a223471e6c584b8f803
parent2a8e6a2f1a8e047a8efd84764d9a332bbd6ae96d (diff)
downloadrneovim-f89e3497c88f59916e3bce2e902be9b0f8bf15ba.tar.gz
rneovim-f89e3497c88f59916e3bce2e902be9b0f8bf15ba.tar.bz2
rneovim-f89e3497c88f59916e3bce2e902be9b0f8bf15ba.zip
docs(lsp): update cmd_env description (#22438)
-rw-r--r--runtime/doc/lsp.txt7
-rw-r--r--runtime/lua/vim/lsp.lua6
2 files changed, 6 insertions, 7 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
index 3b5a434eff..7e46698614 100644
--- a/runtime/doc/lsp.txt
+++ b/runtime/doc/lsp.txt
@@ -851,11 +851,10 @@ start_client({config}) *vim.lsp.start_client()*
• cmd_cwd: (string, default=|getcwd()|) Directory to launch
the `cmd` process. Not related to `root_dir`.
• cmd_env: (table) Environment flags to pass to the LSP on
- spawn. Can be specified using keys like a map or as a list
- with `k=v` pairs or both. Non-string values are coerced to string.
- Example: >
+ spawn. Must be specified using a map-like table.
+ Non-string values are coerced to string. Example: >
- { "PRODUCTION=true"; "TEST=123"; PORT = 8080; HOST = "0.0.0.0"; }
+ { PORT = 8080; HOST = "0.0.0.0"; }
<
• detached: (boolean, default true) Daemonize the server
process so that it runs in a separate process group from
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index d215b4c47e..61a06ff7a7 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -908,11 +908,11 @@ end
--- the `cmd` process. Not related to `root_dir`.
---
--- - cmd_env: (table) Environment flags to pass to the LSP on
---- spawn. Can be specified using keys like a map or as a list with `k=v`
---- pairs or both. Non-string values are coerced to string.
+--- spawn. Must be specified using a map-like table.
+--- Non-string values are coerced to string.
--- Example:
--- <pre>
---- { "PRODUCTION=true"; "TEST=123"; PORT = 8080; HOST = "0.0.0.0"; }
+--- { PORT = 8080; HOST = "0.0.0.0"; }
--- </pre>
---
--- - detached: (boolean, default true) Daemonize the server process so that it runs in a