summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarc-Andre Laperle <marc-andre.laperle@ericsson.com>2017-12-18 14:59:01 +0000
committerMarc-Andre Laperle <marc-andre.laperle@ericsson.com>2017-12-18 14:59:01 +0000
commita1741f28a826c2e38fda73f6070a79b7d2f05e35 (patch)
treedce3e8b32a6773bcd92ed4c2c7f6055908e97ffb
parent9273ad9cdfc8f854530e046232e21ab79169a4fb (diff)
[clangd] Update documentation page with new features, instructions
Summary: - Some features were implemented so mark them as such. - Add installation instructions (LLVM debian packages) Signed-off-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com> Reviewers: jkorous-apple Reviewed By: jkorous-apple Subscribers: jkorous-apple, klimek, ilya-biryukov, cfe-commits Tags: #clang-tools-extra Differential Revision: https://reviews.llvm.org/D41306 git-svn-id: https://llvm.org/svn/llvm-project/clang-tools-extra/trunk@320988 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--docs/clangd.rst33
1 files changed, 25 insertions, 8 deletions
diff --git a/docs/clangd.rst b/docs/clangd.rst
index d7284a2b..c70cf7c0 100644
--- a/docs/clangd.rst
+++ b/docs/clangd.rst
@@ -23,8 +23,20 @@ At the moment, `Visual Studio Code <https://code.visualstudio.com/>`_ is mainly
used in order to test :program:`Clangd` but more clients are likely to make
use of :program:`Clangd` in the future as it matures and becomes a production
quality tool. If you are interested in trying :program:`Clangd` in combination
-with Visual Studio Code, you can start by `building Clangd`_, then open Visual
-Studio Code in the clangd-vscode folder and launch the extension.
+with Visual Studio Code, you can start by `installing Clangd`_ or
+`building Clangd`_, then open Visual Studio Code in the clangd-vscode folder and
+launch the extension.
+
+Installing Clangd
+==================
+
+Packages are available for debian-based distributions, see the `LLVM packages
+page <http://apt.llvm.org/>`_. :program:`Clangd` is included in the
+`clang-tools` package.
+However, it is a good idea to check your distribution's packaging system first
+as it might already be available.
+
+Otherwise, you can install :program:`Clangd` by `building Clangd`_ first.
Building Clangd
==================
@@ -41,7 +53,8 @@ Here is a list of features that could be useful with the status of whether or
not they are already implemented in :program:`Clangd` and specified in the
Language Server Protocol. Note that for some of the features, it is not clear
whether or not they should be part of the Language Server Protocol, so those
-features might be eventually developed outside :program:`Clangd`.
+features might be eventually developed outside :program:`Clangd` or as an
+extension to the protocol.
+-------------------------------------+------------+----------+
| C/C++ Editor feature | LSP | Clangd |
@@ -56,18 +69,22 @@ features might be eventually developed outside :program:`Clangd`.
+-------------------------------------+------------+----------+
| Go to Definition | Yes | Yes |
+-------------------------------------+------------+----------+
-| Source hover | Yes | No |
+| Signature Help | Yes | Yes |
+-------------------------------------+------------+----------+
-| Signature Help | Yes | No |
+| Document Highlights | Yes | Yes |
+-------------------------------------+------------+----------+
-| Find References | Yes | No |
+| Rename | Yes | Yes |
+-------------------------------------+------------+----------+
-| Document Highlights | Yes | No |
+| Source hover | Yes | No |
+-------------------------------------+------------+----------+
-| Rename | Yes | No |
+| Find References | Yes | No |
+-------------------------------------+------------+----------+
| Code Lens | Yes | No |
+-------------------------------------+------------+----------+
+| Document Symbols | Yes | No |
++-------------------------------------+------------+----------+
+| Workspace Symbols | Yes | No |
++-------------------------------------+------------+----------+
| Syntax and Semantic Coloring | No | No |
+-------------------------------------+------------+----------+
| Code folding | No | No |