[clang-tools-extra] r320988 - [clangd] Update documentation page with new features, instructions

[Marc-Andre Laperle via cfe-commits]

Author: malaperle
Date: Mon Dec 18 06:59:01 2017
New Revision: 320988

URL: http://llvm.org/viewvc/llvm-project?rev=320988&view=rev
Log:
[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 at 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

Modified:
    clang-tools-extra/trunk/docs/clangd.rst

Modified: clang-tools-extra/trunk/docs/clangd.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clangd.rst?rev=320988&r1=320987&r2=320988&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/clangd.rst (original)
+++ clang-tools-extra/trunk/docs/clangd.rst Mon Dec 18 06:59:01 2017
@@ -23,8 +23,20 @@ At the moment, `Visual Studio Code <http
 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
 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 o
 +-------------------------------------+------------+----------+
 | 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     |