diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2022-06-13 01:12:52 -0700 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2022-06-13 01:44:59 -0700 |
| commit | 4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176 (patch) | |
| tree | d448c2954948c3c241d3dc86d724f6e964cd3061 /lua | |
| parent | docs: update server_configurations.md (diff) | |
| download | nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.gz nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.bz2 nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.lz nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.xz nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.zst nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.zip | |
docs: unverbose, mention "settings" param
Problem:
- The docs are verbose.
- The "settings" param is not really clarified anywhere.
Solution:
- Mention the "settings" param in the README.
- Tighten up the wording.
- Remove the "Use a loop to conveniently call 'setup'..." advice in the
docs. It confuses users and doesn't really save much code.
- Start to reduce the scope of nvim-lspconfig.
- For example, it is redundant for it to document general LSP things.
Thus, the help section *lspconfig-lsp* was removed.
closes #1951
Diffstat (limited to 'lua')
| -rw-r--r-- | lua/lspconfig/server_configurations/clangd.lua | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/lua/lspconfig/server_configurations/clangd.lua b/lua/lspconfig/server_configurations/clangd.lua index 0dbe2cfd..83cfc56d 100644 --- a/lua/lspconfig/server_configurations/clangd.lua +++ b/lua/lspconfig/server_configurations/clangd.lua @@ -61,9 +61,14 @@ return { description = [[ https://clangd.llvm.org/installation.html -**NOTE:** Clang >= 11 is recommended! See [this issue for more](https://github.com/neovim/nvim-lsp/issues/23). - -clangd relies on a [JSON compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html) specified as compile_commands.json, see https://clangd.llvm.org/installation#compile_commandsjson +- **NOTE:** Clang >= 11 is recommended! See [#23](https://github.com/neovim/nvim-lsp/issues/23). +- If `compile_commands.json` lives in a build directory, you should + symlink it to the root of your source tree. + ``` + ln -s ~/myproject/compile_commands.json ~/myproject/build/ + ``` +- clangd relies on a [JSON compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html) + specified as compile_commands.json, see https://clangd.llvm.org/installation#compile_commandsjson ]], default_config = { root_dir = [[ |
