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

Eric Liu via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Mon Aug 27 05:23:44 PDT 2018


ioeric added a comment.

In https://reviews.llvm.org/D51297#1214297, @ilya-biryukov wrote:

> Do we want to keep the docs for different editors separate or do we want to put them all into a single page in case we add more editors?
>  I would vouch for keeping them on a single page, but that's not a strong opinion. Wonder what other people think?


Looking at the length of the vim integration doc, I think it might make sense to keep the full vim integration doc separate. However, it might still make sense to have short/simplified quick start instructions plus a link to the full doc for more details in the main doc.



================
Comment at: clang-tools-extra/docs/index.rst:29
    clangd
+   clangd-vim
    clang-doc
----------------
`clangd-vim` is not a top-level project. I think this should be linked from clangd documentation.


================
Comment at: clang/docs/ClangFormat.rst:97
 
+Clangd Integration
+==================
----------------
We could recomend formatting with clangd in clangd doc, but advertising here seems a bit odd. I'd suggest dropping this.

And to be fair, clang-format editor plugins seem to be provide finer controls than LSP clients.


https://reviews.llvm.org/D51297





More information about the cfe-commits mailing list