[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Ilya Biryukov via Phabricator via cfe-commits]

ilya-biryukov accepted this revision.
ilya-biryukov added a comment.

LGTM


https://reviews.llvm.org/D51297



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Kirill Bobyrev via Phabricator via cfe-commits]

kbobyrev updated this revision to Diff 165238.
kbobyrev marked an inline comment as done.

https://reviews.llvm.org/D51297

Files:
  clang-tools-extra/docs/clangd.rst


Index: clang-tools-extra/docs/clangd.rst
===
--- clang-tools-extra/docs/clangd.rst
+++ clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,41 @@
 | Gen. Getters/Setters| No |   No |
 +-++--+
 
+Editor Integration
+==
+
+Any full-featured Language Server Protocol Client implementation should work
+with :program:`Clangd`. This `list
+` 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
+`_ plugin. Please see the
+`Clangd Wiki page
+`_ for
+instructions.
+
+VSCode Integration
+--
+
+:program:`VSCode` provides `vscode-clangd
+`
+which is published in Visual Studio Marketplace and can be installed direcetly
+from :program:`VSCode`.
+
+Emacs Integration
+-
+
+:program:`Emacs` provides `lsp-mode ` and
+`Eglot ` plugins for LSP integration.
+
 Getting Involved
 ==
 


Index: clang-tools-extra/docs/clangd.rst
===
--- clang-tools-extra/docs/clangd.rst
+++ clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,41 @@
 | Gen. Getters/Setters| No |   No |
 +-++--+
 
+Editor Integration
+==
+
+Any full-featured Language Server Protocol Client implementation should work
+with :program:`Clangd`. This `list
+` 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
+`_ plugin. Please see the
+`Clangd Wiki page
+`_ for
+instructions.
+
+VSCode Integration
+--
+
+:program:`VSCode` provides `vscode-clangd
+`
+which is published in Visual Studio Marketplace and can be installed direcetly
+from :program:`VSCode`.
+
+Emacs Integration
+-
+
+:program:`Emacs` provides `lsp-mode ` and
+`Eglot ` plugins for LSP integration.
+
 Getting Involved
 ==
 
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Kirill Bobyrev via Phabricator via cfe-commits]

kbobyrev added inline comments.



Comment at: clang-tools-extra/docs/clangd.rst:135
+
+:program:`VSCode` provides `vscode-clangd
+`

ilya-biryukov wrote:
> Maybe mention it is published in "Visual Studio Marketplace" and can be 
> installed directly from VSCode?
> 
Right, I thought it might make sense to mention that it is developed in-tree 
here, but since it's the "Editor Integration" section it's probably not worth 
here and I also didn't notice this mention on top of the documentation page.


https://reviews.llvm.org/D51297



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Ilya Biryukov via Phabricator via cfe-commits]

ilya-biryukov added inline comments.



Comment at: clang-tools-extra/docs/clangd.rst:135
+
+:program:`VSCode` provides `vscode-clangd
+`

Maybe mention it is published in "Visual Studio Marketplace" and can be 
installed directly from VSCode?



https://reviews.llvm.org/D51297



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Kirill Bobyrev via Phabricator via cfe-commits]

kbobyrev updated this revision to Diff 165228.
kbobyrev added a comment.

Create different sections for few editors, link web page with the complete list 
of LSP clients.


https://reviews.llvm.org/D51297

Files:
  clang-tools-extra/docs/clangd.rst


Index: clang-tools-extra/docs/clangd.rst
===
--- clang-tools-extra/docs/clangd.rst
+++ clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,40 @@
 | Gen. Getters/Setters| No |   No |
 +-++--+
 
+Editor Integration
+==
+
+Any full-featured Language Server Protocol Client implementation should work
+with :program:`Clangd`. This `list
+` 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
+`_ plugin. Please see the
+`Clangd Wiki page
+`_ for
+instructions.
+
+VSCode Integration
+--
+
+:program:`VSCode` provides `vscode-clangd
+`
+which is developed as a part of Clang-Tools-Extra source tree.
+
+Emacs Integration
+-
+
+:program:`Emacs` provides `lsp-mode ` and
+`Eglot ` plugins for LSP integration.
+
 Getting Involved
 ==
 


Index: clang-tools-extra/docs/clangd.rst
===
--- clang-tools-extra/docs/clangd.rst
+++ clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,40 @@
 | Gen. Getters/Setters| No |   No |
 +-++--+
 
+Editor Integration
+==
+
+Any full-featured Language Server Protocol Client implementation should work
+with :program:`Clangd`. This `list
+` 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
+`_ plugin. Please see the
+`Clangd Wiki page
+`_ for
+instructions.
+
+VSCode Integration
+--
+
+:program:`VSCode` provides `vscode-clangd
+`
+which is developed as a part of Clang-Tools-Extra source tree.
+
+Emacs Integration
+-
+
+:program:`Emacs` provides `lsp-mode ` and
+`Eglot ` plugins for LSP integration.
+
 Getting Involved
 ==
 
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Eric Liu via Phabricator via cfe-commits]

ioeric added inline comments.



Comment at: clang-tools-extra/docs/clangd.rst:114
+
+There are multiple editors and plugins that are known to work with Clangd, such
+as :program:`VSCode` and ``vscode-clangd`` extension, :program:`Emacs` and

Thanks!

I would be nice if other editors can get their own sections like vim does :) 
For example:

```
vscode
(Something like vscode works well with clangd)

Vim
...

Emacs
(Eglot)
```


https://reviews.llvm.org/D51297



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Eric Liu via Phabricator via cfe-commits]

ioeric accepted this revision.
ioeric added inline comments.
This revision is now accepted and ready to land.



Comment at: clang-tools-extra/docs/clangd.rst:114
+
+There are multiple editors and plugins that are known to work with Clangd, such
+as :program:`VSCode` and ``vscode-clangd`` extension, :program:`Emacs` and

ioeric wrote:
> Thanks!
> 
> I would be nice if other editors can get their own sections like vim does :) 
> For example:
> 
> ```
> vscode
> (Something like vscode works well with clangd)
> 
> Vim
> ...
> 
> Emacs
> (Eglot)
> ```
*It* would be nice...


https://reviews.llvm.org/D51297



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Kirill Bobyrev via Phabricator via cfe-commits]

kbobyrev updated this revision to Diff 165210.
kbobyrev marked an inline comment as done.

https://reviews.llvm.org/D51297

Files:
  clang-tools-extra/docs/clangd.rst


Index: clang-tools-extra/docs/clangd.rst
===
--- clang-tools-extra/docs/clangd.rst
+++ clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,26 @@
 | Gen. Getters/Setters| No |   No |
 +-++--+
 
+Editor Integration
+==
+
+There are multiple editors and plugins that are known to work with Clangd, such
+as :program:`VSCode` and ``vscode-clangd`` extension, :program:`Emacs` and
+``Eglot`` plugin. Any full-featured LSP client should work with Clangd.
+
+Vim Integration
+---
+
+LanguageClient-neovim
+~
+
+One of the options of using :program:`Clangd` in :program:`vim` (or
+:program:`nvim`) is to utilize `LanguageClient-neovim
+`_ plugin. Please see the
+`Clangd Wiki page
+`_ for
+instructions.
+
 Getting Involved
 ==
 


Index: clang-tools-extra/docs/clangd.rst
===
--- clang-tools-extra/docs/clangd.rst
+++ clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,26 @@
 | Gen. Getters/Setters| No |   No |
 +-++--+
 
+Editor Integration
+==
+
+There are multiple editors and plugins that are known to work with Clangd, such
+as :program:`VSCode` and ``vscode-clangd`` extension, :program:`Emacs` and
+``Eglot`` plugin. Any full-featured LSP client should work with Clangd.
+
+Vim Integration
+---
+
+LanguageClient-neovim
+~
+
+One of the options of using :program:`Clangd` in :program:`vim` (or
+:program:`nvim`) is to utilize `LanguageClient-neovim
+`_ plugin. Please see the
+`Clangd Wiki page
+`_ for
+instructions.
+
 Getting Involved
 ==
 
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Eric Liu via Phabricator via cfe-commits]

ioeric added inline comments.



Comment at: clang-tools-extra/docs/clangd.rst:111
 
+Editor Integration
+==

While we are here, would you mind including some other editors/plugins that are 
known to work with clangd (just so that people don't think vim is the only 
editor that works)? E.g. `Eglot` works on emacs, `vscode` apparently works as 
well. 

We should also mention that any other LSP clients should work with clangd in 
theory.


https://reviews.llvm.org/D51297



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Kirill Bobyrev via Phabricator via cfe-commits]

kbobyrev updated this revision to Diff 164841.
kbobyrev added a comment.

Outline the structure for "Editor Integration" section which is to be filled 
with other options later.


https://reviews.llvm.org/D51297

Files:
  clang-tools-extra/docs/clangd.rst


Index: clang-tools-extra/docs/clangd.rst
===
--- clang-tools-extra/docs/clangd.rst
+++ clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,22 @@
 | Gen. Getters/Setters| No |   No |
 +-++--+
 
+Editor Integration
+==
+
+Vim Integration
+---
+
+LanguageClient-neovim
+~
+
+One of the options of using :program:`Clangd` in :program:`vim` (or
+:program:`nvim`) is to utilize `LanguageClient-neovim
+`_ plugin. Please see the
+`Clangd Wiki page
+`_ for
+instructions.
+
 Getting Involved
 ==
 


Index: clang-tools-extra/docs/clangd.rst
===
--- clang-tools-extra/docs/clangd.rst
+++ clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,22 @@
 | Gen. Getters/Setters| No |   No |
 +-++--+
 
+Editor Integration
+==
+
+Vim Integration
+---
+
+LanguageClient-neovim
+~
+
+One of the options of using :program:`Clangd` in :program:`vim` (or
+:program:`nvim`) is to utilize `LanguageClient-neovim
+`_ plugin. Please see the
+`Clangd Wiki page
+`_ for
+instructions.
+
 Getting Involved
 ==
 
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D51297: [docs] Create a guide for Vim users on how to set up Clangd

[Kadir Cetinkaya via Phabricator via cfe-commits]

kadircet added a comment.

In https://reviews.llvm.org/D51297#1228725, @ioeric wrote:

> I also support having some instructions/pointers on editor integration. That 
> said, I think we should have a section "Editor integration" with a list of 
> editor clients that are known to work with clangd, instead of having a 
> section just for vim. Something like:
>
>   #Editor (or client?) integration
>  
>   ##Vim
>   Some LSP clients that are known to work with clangd:
>- nvim, LanguageClient-neovim ..
>- ...
>  
>   ## vscode
>  
>   ## emacs?
>  
>
>
> What do you think?


Sorry I am trespassing, just wanted to say +1 to this.


https://reviews.llvm.org/D51297



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits