summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKirill Bobyrev <kbobyrev.opensource@gmail.com>2018-09-13 11:40:12 +0000
committerKirill Bobyrev <kbobyrev.opensource@gmail.com>2018-09-13 11:40:12 +0000
commit778e0d24eebf6d29ef33fd61cc92724c0aead03e (patch)
tree0480792b396265d0324710ba3dc0e2987ea35065
parent5b65e41a8f022cecd7d98b24c34b1246db7bc4a6 (diff)
downloadbcm5719-llvm-778e0d24eebf6d29ef33fd61cc92724c0aead03e.tar.gz
bcm5719-llvm-778e0d24eebf6d29ef33fd61cc92724c0aead03e.zip
[docs] Provide pointers to known editor plugins and extensions
Many editors provide extensions and plugins with LSP Client functionality. Many of these are known to work with Clangd, this patch points users to the relevant resources for better experience. Reviewed By: ioeric, ilya-biryukov Differential Revision llvm-svn: 342129
-rw-r--r--clang-tools-extra/docs/clangd.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/clang-tools-extra/docs/clangd.rst b/clang-tools-extra/docs/clangd.rst
index e2d18fd41bf..cd059955782 100644
--- a/clang-tools-extra/docs/clangd.rst
+++ b/clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,41 @@ extension to the protocol.
| Gen. Getters/Setters | No | No |
+-------------------------------------+------------+----------+
+Editor Integration
+==================
+
+Any full-featured Language Server Protocol Client implementation should work
+with :program:`Clangd`. This `list
+<https://langserver.org/#implementations-client>` contains information about
+extensions and plugins that are known to work for different editors.
+
+Vim Integration
+---------------
+
+LanguageClient-neovim
+~~~~~~~~~~~~~~~~~~~~~
+
+One of the options of using :program:`Clangd` in :program:`vim` (or
+:program:`nvim`) is to utilize `LanguageClient-neovim
+<https://github.com/autozimu/LanguageClient-neovim>`_ plugin. Please see the
+`Clangd Wiki page
+<https://github.com/autozimu/LanguageClient-neovim/wiki/Clangd>`_ for
+instructions.
+
+VSCode Integration
+------------------
+
+:program:`VSCode` provides `vscode-clangd
+<https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd>`
+which is published in Visual Studio Marketplace and can be installed direcetly
+from :program:`VSCode`.
+
+Emacs Integration
+-----------------
+
+:program:`Emacs` provides `lsp-mode <github.com/emacs-lsp/lsp-mode>` and
+`Eglot <https://github.com/joaotavora/eglot>` plugins for LSP integration.
+
Getting Involved
==================
OpenPOWER on IntegriCloud