Commit f7be79e5 authored by Hans Wennborg's avatar Hans Wennborg
Browse files

Merging r354777, r354778, r354779, r354786, r354865, and r354992 

------------------------------------------------------------------------
r354777 | gribozavr | 2019-02-25 13:48:52 +0100 (Mon, 25 Feb 2019) | 9 lines

Removed an unhelpful comment in index.rst

Reviewers: ilya-biryukov

Subscribers: arphaman, jdoerfert, cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D58602
------------------------------------------------------------------------

------------------------------------------------------------------------
r354778 | gribozavr | 2019-02-25 13:49:27 +0100 (Mon, 25 Feb 2019) | 7 lines

Fixed grammar in index.rst

Subscribers: arphaman, cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D58601
------------------------------------------------------------------------

------------------------------------------------------------------------
r354779 | gribozavr | 2019-02-25 14:03:44 +0100 (Mon, 25 Feb 2019) | 9 lines

Updated the documentation build instructions for the current CMake build system

Reviewers: ilya-biryukov

Subscribers: cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D58603
------------------------------------------------------------------------

------------------------------------------------------------------------
r354786 | gribozavr | 2019-02-25 14:43:48 +0100 (Mon, 25 Feb 2019) | 9 lines

Moved clangd docs to a separate directory in preparation to restructure them into multiple files

Reviewers: ilya-biryukov

Subscribers: ioeric, MaskRay, jkorous, arphaman, kadircet, jdoerfert, cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D58607
------------------------------------------------------------------------

------------------------------------------------------------------------
r354865 | kadircet | 2019-02-26 12:08:04 +0100 (Tue, 26 Feb 2019) | 11 lines

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

Reviewers: gribozavr

Reviewed By: gribozavr

Subscribers: ilya-biryukov, ioeric, MaskRay, jkorous, arphaman, cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D56718
------------------------------------------------------------------------

------------------------------------------------------------------------
r354992 | gribozavr | 2019-02-27 16:53:05 +0100 (Wed, 27 Feb 2019) | 13 lines

Added more detailed documentation for clangd

Summary:
The text was written mostly by Sam McCall, screenshots are mostly made
by me.

Reviewers: ilya-biryukov

Subscribers: ioeric, MaskRay, jkorous, arphaman, kadircet, jdoerfert, cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D58710
------------------------------------------------------------------------

llvm-svn: 354997
parent 8c0e32b8

clang-tools-extra/docs/README.txt

+7 −8
Original line number Diff line number Diff line 
-------------------------------------------------------------

Documentation for the tools of clang-tools-extra repo project

-------------------------------------------------------------

----------------------------------

Documentation in clang-tools-extra

----------------------------------



Sphinx and doxygen documentation is generated by executing make.

To generate documentation in HTML format from files in clang-tools-extra/docs,

build the docs-clang-tools-html target.



Sphinx html files can be generated separately using make html.

To generate documentation from the source code using Doxygen, build the

doxygen-clang-tools target.

Doxygen html files can also be generated using make doxygen.



The generated documentation will be placed in _build/html.

clang-tools-extra/docs/_static/clang-tools-extra-styles.css

0 → 100644
+23 −0
Original line number Diff line number Diff line 
details {

  background-color: rgba(50, 150, 220, 0.08);

  margin-bottom: 0.5em;

  padding: 0 1em;

  overflow-y: hidden; /* Suppress margin-collapsing */

}

details[open] {

  border-bottom: 1px solid rgba(0, 0, 128, 0.2);

  margin-bottom: 1em;

}

details summary {

  font-weight: bold;

  background-color: rgba(50, 150, 220, 0.1);

  border-color: rgba(0, 0, 128, 0.2);

  border-width: 1px;

  border-style: solid none;

  padding: 0.2em;

  margin: 0 -1em;

}

details summary:hover {

  background-color: rgba(50, 150, 220, 0.2);

  cursor: pointer;

}

clang-tools-extra/docs/_templates/layout.html

0 → 100644
+3 −0
Original line number Diff line number Diff line 
{% extends "!layout.html" %}



{% set css_files = css_files + ['_static/clang-tools-extra-styles.css'] %}

clang-tools-extra/docs/clangd.rst

+1 −161
Original line number Diff line number Diff line 
============

Clangd

============



.. contents::



.. toctree::

   :maxdepth: 1



:program:`Clangd` is an implementation of the `Language Server Protocol

<https://github.com/Microsoft/language-server-protocol>`_ leveraging Clang.

Clangd's goal is to provide language "smartness" features like code completion,

find references, etc. for clients such as C/C++ Editors.



Using Clangd

==================



:program:`Clangd` is not meant to be used by C/C++ developers directly but

rather from a client implementing the protocol. A client would be typically

implemented in an IDE or an editor.



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 `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

==================



You can follow the instructions for `building Clang

<https://clang.llvm.org/get_started.html>`_ but "extra Clang tools" is **not**

optional.



Current Status

==================



Many features could be implemented in :program:`Clangd`.

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` or as an

extension to the protocol.



+-------------------------------------+------------+----------+

| C/C++ Editor feature                |  LSP       |  Clangd  |

+=====================================+============+==========+

| Formatting                          | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Completion                          | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Diagnostics                         | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Fix-its                             | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Go to Definition                    | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Signature Help                      | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Document Highlights                 | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Rename                              | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Source hover                        | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Find References                     | Yes        |   No     |

+-------------------------------------+------------+----------+

| Code Lens                           | Yes        |   No     |

+-------------------------------------+------------+----------+

| Document Symbols                    | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Workspace Symbols                   | Yes        |   Yes    |

+-------------------------------------+------------+----------+

| Syntax and Semantic Coloring        | No         |   No     |

+-------------------------------------+------------+----------+

| Code folding                        | No         |   No     |

+-------------------------------------+------------+----------+

| Call hierarchy                      | No         |   No     |

+-------------------------------------+------------+----------+

| Type hierarchy                      | No         |   No     |

+-------------------------------------+------------+----------+

| Organize Includes                   | No         |   No     |

+-------------------------------------+------------+----------+

| Quick Assist                        | No         |   No     |

+-------------------------------------+------------+----------+

| Extract Local Variable              | No         |   No     |

+-------------------------------------+------------+----------+

| Extract Function/Method             | No         |   No     |

+-------------------------------------+------------+----------+

| Hide Method                         | No         |   No     |

+-------------------------------------+------------+----------+

| Implement Method                    | No         |   No     |

+-------------------------------------+------------+----------+

| Gen. Getters/Setters                | No         |   No     |

+-------------------------------------+------------+----------+



Editor Integration

==================



Any full-featured Language Server Protocol Client implementation should work

with :program:`Clangd`. This `list

<https://langserver.org/#implementations-client>`_ 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

<https://github.com/autozimu/LanguageClient-neovim>`_ plugin. Please see the

`Clangd Wiki page

<https://github.com/autozimu/LanguageClient-neovim/wiki/Clangd>`_ for

instructions.



VSCode Integration

------------------



:program:`VSCode` provides `vscode-clangd

<https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd>`_

which is published in Visual Studio Marketplace and can be installed direcetly

from :program:`VSCode`.



Emacs Integration

-----------------



:program:`Emacs` provides `lsp-mode <github.com/emacs-lsp/lsp-mode>`_ and

`Eglot <https://github.com/joaotavora/eglot>`_ plugins for LSP integration.



Getting Involved

==================



A good place for interested contributors is the `Clangd developer mailing list

<http://lists.llvm.org/mailman/listinfo/clangd-dev>`_. For discussions with the

broader community on topics not only related to Clangd, use

`Clang developer mailing list

<http://lists.llvm.org/mailman/listinfo/cfe-dev>`_.

If you're also interested in contributing patches to :program:`Clangd`, take a

look at the `LLVM Developer Policy

<http://llvm.org/docs/DeveloperPolicy.html>`_ and `Code Reviews

<http://llvm.org/docs/Phabricator.html>`_ page. Contributions of new features

to the `Language Server Protocol

<https://github.com/Microsoft/language-server-protocol>`_ itself would also be

very useful, so that :program:`Clangd` can eventually implement them in a

conforming way.
 
:orphan:

clang-tools-extra/docs/clangd/ApplyClangTidyFixInVSCode.gif

0 → 100644
+93 KiB
Loading image diff...