aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGithub Actions <actions@github>2021-07-26 19:53:24 +0000
committerGithub Actions <actions@github>2021-07-26 19:53:24 +0000
commit316a9e824bb0bdc8252a77ba4d4bcbf70861517f (patch)
tree5684b80a3e828a3249e6072a8641d83e1f4a1cb0 /doc
parentdocs: mention the minimal init.lua in debugging (diff)
downloadnvim-lspconfig-316a9e824bb0bdc8252a77ba4d4bcbf70861517f.tar
nvim-lspconfig-316a9e824bb0bdc8252a77ba4d4bcbf70861517f.tar.gz
nvim-lspconfig-316a9e824bb0bdc8252a77ba4d4bcbf70861517f.tar.bz2
nvim-lspconfig-316a9e824bb0bdc8252a77ba4d4bcbf70861517f.tar.lz
nvim-lspconfig-316a9e824bb0bdc8252a77ba4d4bcbf70861517f.tar.xz
nvim-lspconfig-316a9e824bb0bdc8252a77ba4d4bcbf70861517f.tar.zst
nvim-lspconfig-316a9e824bb0bdc8252a77ba4d4bcbf70861517f.zip
[docgen] Update README.md
skip-checks: true
Diffstat (limited to 'doc')
-rw-r--r--doc/lspconfig.txt3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/lspconfig.txt b/doc/lspconfig.txt
index 3294ffc2..a53e40f7 100644
--- a/doc/lspconfig.txt
+++ b/doc/lspconfig.txt
@@ -174,7 +174,8 @@ server attaches to the current buffer.
8. Debugging *lspconfig-debugging*
-The two most common reasons a language server does not start or attach are:
+If you have an issue with lspconfig, the first step is to reproduce with a [minimal configuration](https://github.com/neovim/nvim-lspconfig/blob/master/test/minimal_init.lua).
+The most common reasons a language server does not start or attach are:
1. The language server is not installed. nvim-lspconfig does not install language servers for you. You should be able to run the `cmd` defined in each server's lua module from the command line and see that the language server starts. If the `cmd` is an executable name, ensure it is on your path.
2. Not triggering root detection. The language server will only start if it is opened in a directory, or child directory, containing a file which signals the *root* of the project. Most of the time, this is a `.git` folder, but each server defines the root config in the lua file. See [CONFIG.md](CONFIG.md) or the source for the list of root directories.
3. Misconfiguration. You must pass `on_attach` and `capabilities` for **each** `setup {}` if you want these to take effect. You must also **not call `setup {}` twice for the same server**. The second call to `setup {}` will overwrite the first.