This is an archive of the discontinued LLVM Phabricator instance.

Differential D56718

[clangd] Update docs to mention YCM integration and new LSP features
ClosedPublic

Authored by kadircet on Jan 15 2019, 6:10 AM.

Details

Reviewers
gribozavr
Commits
rCTE354865: [clangd] Update docs to mention YCM integration and new LSP features
rG8335fd1923c1: [clangd] Update docs to mention YCM integration and new LSP features
rL354865: [clangd] Update docs to mention YCM integration and new LSP features

Diff Detail

Event Timeline

kadircet created this revision.Jan 15 2019, 6:10 AM
Herald added subscribers: cfe-commits, arphaman, jkorous and 3 others. · View Herald TranscriptJan 15 2019, 6:10 AM
Harbormaster completed remote builds in B26859: Diff 181774.Jan 15 2019, 6:11 AM
ilya-biryukov added inline comments.Jan 15 2019, 9:24 AM
docs/clangd.rst
125

Given how little information we actually provide for each option here (it's literally just pointers to the docs), maybe make this a list instead to avoid copy-pasting between those two?
Something like:

You can use Clangd in vim with one of the following plugins:

  • YouCompleteMe, see installation instructions.
  • LanguageClient-neovim, see clangd wiki page for instructions.
129

I believe this does not mention how to install clangd, though (and libclang-based is still the default, right?) Do we want to mention how to configure it to use clangd here?

kadircet marked an inline comment as done.Jan 16 2019, 2:34 AM
kadircet added inline comments.
docs/clangd.rst
129

That's actually the reason I haven't submitted this one for review. I am preparing a PR to YCM folks which will hopefully include clangd in installation process

kadircet updated this revision to Diff 188327.Feb 26 2019, 2:57 AM
  • Revert YCM related parts
Herald added a project: Restricted Project. · View Herald TranscriptFeb 26 2019, 2:57 AM
kadircet added a reviewer: gribozavr.Feb 26 2019, 2:57 AM
gribozavr accepted this revision.Feb 26 2019, 2:59 AM
This revision is now accepted and ready to land.Feb 26 2019, 2:59 AM
Harbormaster completed remote builds in B28539: Diff 188327.Feb 26 2019, 3:02 AM
kadircet updated this revision to Diff 188329.Feb 26 2019, 3:05 AM
  • Rebase
Harbormaster completed remote builds in B28540: Diff 188329.Feb 26 2019, 3:07 AM
Closed by commit rL354865: [clangd] Update docs to mention YCM integration and new LSP features (authored by kadircet). · Explain WhyFeb 26 2019, 3:13 AM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptFeb 26 2019, 3:13 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript

Revision Contents

PathSize
docs/
37 lines

Diff 181774

docs/clangd.rst

Show First 20 Lines • Show All 71 Lines • ▼ Show 20 Lines
| Signature Help | Yes | Yes | | Signature Help | Yes | Yes |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Document Highlights | Yes | Yes | | Document Highlights | Yes | Yes |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Rename | Yes | Yes | | Rename | Yes | Yes |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Source hover | Yes | Yes | | Source hover | Yes | Yes |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Find References | Yes | No | | Find References | Yes | Yes |
+-------------------------------------+------------+----------+
| Code Lens | Yes | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Document Symbols | Yes | Yes | | Document Symbols | Yes | Yes |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Workspace Symbols | Yes | Yes | | Workspace Symbols | Yes | Yes |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Syntax and Semantic Coloring | No | No | | Code Lens | Yes | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Code folding | No | No | | Code folding | Yes | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Call hierarchy | No | No | | Extract Local Variable | Yes | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Type hierarchy | No | No | | Extract Function/Method | Yes | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Organize Includes | No | No | | Quick Assist | Yes | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Quick Assist | No | No | | Hide Method | Yes | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Extract Local Variable | No | No | | Implement Method | Yes | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Extract Function/Method | No | No | | Gen. Getters/Setters | Yes | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Hide Method | No | No | | Syntax and Semantic Coloring | No | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Implement Method | No | No | | Call hierarchy | No | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
| Gen. Getters/Setters | No | No | | Type hierarchy | No | No |
+-------------------------------------+------------+----------+
| Organize Includes | No | No |
+-------------------------------------+------------+----------+ +-------------------------------------+------------+----------+
Editor Integration Editor Integration
================== ==================
Any full-featured Language Server Protocol Client implementation should work Any full-featured Language Server Protocol Client implementation should work
with :program:`Clangd`. This `list with :program:`Clangd`. This `list
<https://langserver.org/#implementations-client>`_ contains information about <https://langserver.org/#implementations-client>`_ contains information about
extensions and plugins that are known to work for different editors. extensions and plugins that are known to work for different editors.
Vim Integration Vim Integration
--------------- ---------------
YouCompleteMe
~~~~~~~~~~~~~
One of the options of using :program:`Clangd` in :program:`vim` is to utilize
ilya-biryukovUnsubmitted
Not Done
ReplyInline Actions

Given how little information we actually provide for each option here (it's literally just pointers to the docs), maybe make this a list instead to avoid copy-pasting between those two?
Something like:

You can use Clangd in vim with one of the following plugins:

  • YouCompleteMe, see installation instructions.
  • LanguageClient-neovim, see clangd wiki page for instructions.
ilya-biryukov: Given how little information we actually provide for each option here (it's literally just…
`YouCompleteMe
<https://valloric.github.io/YouCompleteMe/>`_ plugin. Please see the
`Installation section on your OS
<https://valloric.github.io/YouCompleteMe/#installation>`_ for instructions.
ilya-biryukovUnsubmitted
Not Done
ReplyInline Actions

I believe this does not mention how to install clangd, though (and libclang-based is still the default, right?) Do we want to mention how to configure it to use clangd here?

ilya-biryukov: I believe this does not mention how to install clangd, though (and libclang-based is still the…
kadircetAuthorUnsubmitted
Done
ReplyInline Actions

That's actually the reason I haven't submitted this one for review. I am preparing a PR to YCM folks which will hopefully include clangd in installation process

kadircet: That's actually the reason I haven't submitted this one for review. I am preparing a PR to YCM…
LanguageClient-neovim LanguageClient-neovim
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
One of the options of using :program:`Clangd` in :program:`vim` (or One of the options of using :program:`Clangd` in :program:`vim` (or
:program:`nvim`) is to utilize `LanguageClient-neovim :program:`nvim`) is to utilize `LanguageClient-neovim
<https://github.com/autozimu/LanguageClient-neovim>`_ plugin. Please see the <https://github.com/autozimu/LanguageClient-neovim>`_ plugin. Please see the
`Clangd Wiki page `Clangd Wiki page
<https://github.com/autozimu/LanguageClient-neovim/wiki/Clangd>`_ for <https://github.com/autozimu/LanguageClient-neovim/wiki/Clangd>`_ for
Show All 32 Lines