diff options
| author | Mathias Fußenegger <mfussenegger@users.noreply.github.com> | 2022-09-08 19:25:16 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-08 10:25:16 -0700 |
| commit | 19a3b2c26e28382a65529a38be9ff63ca58cc023 (patch) | |
| tree | 9c7526fe828af6d64d337ffd7966229a7ceae0b9 | |
| parent | 30ca6d23a9c77175a76a4cd59da81de83d9253af (diff) | |
| download | rneovim-19a3b2c26e28382a65529a38be9ff63ca58cc023.tar.gz rneovim-19a3b2c26e28382a65529a38be9ff63ca58cc023.tar.bz2 rneovim-19a3b2c26e28382a65529a38be9ff63ca58cc023.zip | |
docs(lsp): update rpc.start stdio limitations (#20120)
| -rw-r--r-- | runtime/doc/lsp.txt | 5 | ||||
| -rw-r--r-- | runtime/lua/vim/lsp/rpc.lua | 3 |
2 files changed, 5 insertions, 3 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index a3d21cc6f7..00aaf759e2 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -1962,8 +1962,9 @@ rpc_response_error({code}, {message}, {data}) *vim.lsp.rpc.start()* start({cmd}, {cmd_args}, {dispatchers}, {extra_spawn_params}) Starts an LSP server process and create an LSP RPC client object to - interact with it. Communication with the server is currently limited to - stdio. + interact with it. Communication with the spawned process happens via + stdio. For communication via TCP, spawn a process manually and use + |vim.lsp.rpc.connect| Parameters: ~ {cmd} (string) Command to start the LSP server. diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua index 70f838f34d..7d047f8958 100644 --- a/runtime/lua/vim/lsp/rpc.lua +++ b/runtime/lua/vim/lsp/rpc.lua @@ -635,7 +635,8 @@ local function connect(host, port) end --- Starts an LSP server process and create an LSP RPC client object to ---- interact with it. Communication with the server is currently limited to stdio. +--- interact with it. Communication with the spawned process happens via stdio. For +--- communication via TCP, spawn a process manually and use |vim.lsp.rpc.connect| --- ---@param cmd (string) Command to start the LSP server. ---@param cmd_args (table) List of additional string arguments to pass to {cmd}. |