docs: Update instructions for debugging LSP (#39527)

docs: update instructions for debugging LSP

Previously, it was suggested to set:

    vim.lsp.log.set_format_func(vim.inspect)

This made sense before f72c13341a, when
`format_func` was called once per argument being logged, but since that
commit it's called with the log level followed by the other args, so the
suggested setting would call `vim.inspect(log_level, ....)` which would
just print the human readable name of the current log level and no other
details, for example with this set I saw in my logs:

    "DEBUG""DEBUG""DEBUG""DEBUG"

Instead just rely on the default formatter, which will:

> ... log the level, date, source and line number of the
caller, followed by the arguments.

(cherry picked from commit 578727c25e)
This commit is contained in:
Matthew Hughes
2026-05-01 07:28:22 +10:00
committed by github-actions[bot]
parent 4b424a06c5
commit 20a2398877
2 changed files with 0 additions and 2 deletions

View File

@@ -2542,7 +2542,6 @@ The `vim.lsp.log` module provides logging for the Nvim LSP client.
When debugging language servers, it is helpful to enable extra-verbose logging
of the LSP client RPC events. Example: >lua
vim.lsp.log.set_level 'trace'
vim.lsp.log.set_format_func(vim.inspect)
<
Then try to run the language server, and open the log with: >vim

View File

@@ -5,7 +5,6 @@
--- RPC events. Example:
--- ```lua
--- vim.lsp.log.set_level 'trace'
--- vim.lsp.log.set_format_func(vim.inspect)
--- ```
---
--- Then try to run the language server, and open the log with: