[PATCH] D58710: Added more detailed documentation for clangd

2019-07-15 Thread Kadir Cetinkaya via Phabricator via cfe-commits 
kadircet added inline comments.



Comment at: clang-tools-extra/trunk/docs/clangd/Installation.rst:325
+
+  $ ln -s ~/myproject/compile_commands.json ~/myproject-build/
+

thakis wrote:
> Isn't the order of the arguments the wrong way round here?
yeah that seems to be the case it should rather be

`$ ln -s ~/myproject-build/compile_commands.json ~/myproject/`

sending out a patch, thanks for bringing it up!


Repository:
  rL LLVM

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D58710: Added more detailed documentation for clangd

2019-07-15 Thread Nico Weber via Phabricator via cfe-commits 
thakis added inline comments.



Comment at: clang-tools-extra/trunk/docs/clangd/Installation.rst:325
+
+  $ ln -s ~/myproject/compile_commands.json ~/myproject-build/
+

Isn't the order of the arguments the wrong way round here?


Repository:
  rL LLVM

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
This revision was automatically updated to reflect the committed changes.
Closed by commit rL354992: Added more detailed documentation for clangd 
(authored by gribozavr, committed by ).
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Changed prior to commit:
  https://reviews.llvm.org/D58710?vs=188536=188539#toc

Repository:
  rL LLVM

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710

Files:
  clang-tools-extra/trunk/docs/_static/clang-tools-extra-styles.css
  clang-tools-extra/trunk/docs/_templates/layout.html
  clang-tools-extra/trunk/docs/clangd/ApplyClangTidyFixInVSCode.gif
  clang-tools-extra/trunk/docs/clangd/ApplyFixInVSCode.gif
  clang-tools-extra/trunk/docs/clangd/CodeCompletionInEmacsCompanyMode.png
  clang-tools-extra/trunk/docs/clangd/CodeCompletionInSublimeText.png
  clang-tools-extra/trunk/docs/clangd/CodeCompletionInVSCode.png
  clang-tools-extra/trunk/docs/clangd/CodeCompletionInYCM.png
  
clang-tools-extra/trunk/docs/clangd/CodeCompletionInsertsNamespaceQualifiersInVSCode.gif
  clang-tools-extra/trunk/docs/clangd/DeveloperDocumentation.rst
  clang-tools-extra/trunk/docs/clangd/DiagnosticsInEmacsEglot.png
  clang-tools-extra/trunk/docs/clangd/ErrorsInVSCode.png
  clang-tools-extra/trunk/docs/clangd/Extensions.rst
  clang-tools-extra/trunk/docs/clangd/Features.rst
  clang-tools-extra/trunk/docs/clangd/FindAllReferencesInVSCode.gif
  clang-tools-extra/trunk/docs/clangd/FormatSelectionInVSCode.gif
  clang-tools-extra/trunk/docs/clangd/GoToDefinitionInVSCode.gif
  clang-tools-extra/trunk/docs/clangd/Installation.rst
  clang-tools-extra/trunk/docs/clangd/NavigationWithBreadcrumbsInVSCode.gif
  clang-tools-extra/trunk/docs/clangd/OutlineInVSCode.png
  clang-tools-extra/trunk/docs/clangd/SignatureHelpInVSCode.gif
  clang-tools-extra/trunk/docs/clangd/index.rst
  clang-tools-extra/trunk/docs/conf.py
  clang-tools-extra/trunk/docs/index.rst

Index: clang-tools-extra/trunk/docs/_templates/layout.html
===
--- clang-tools-extra/trunk/docs/_templates/layout.html
+++ clang-tools-extra/trunk/docs/_templates/layout.html
@@ -0,0 +1,3 @@
+{% extends "!layout.html" %}
+
+{% set css_files = css_files + ['_static/clang-tools-extra-styles.css'] %}
Index: clang-tools-extra/trunk/docs/clangd/Installation.rst
===
--- clang-tools-extra/trunk/docs/clangd/Installation.rst
+++ clang-tools-extra/trunk/docs/clangd/Installation.rst
@@ -0,0 +1,369 @@
+===
+Getting started with clangd
+===
+
+.. role:: raw-html(raw)
+   :format: html
+
+To use clangd, you need to:
+
+- install clangd,
+- install a plugin for your editor,
+- tell clangd how your project is built.
+
+Installing clangd
+=
+
+You need a **recent** version of clangd: 7.0 was the first usable release, and
+8.0 is much better.
+
+After installing, ``clangd --version`` should print ``clangd version 7.0.0`` or
+later.
+
+:raw-html:`macOS`
+
+`Homebrew `__ can install clangd along with LLVM:
+
+.. code-block:: console
+
+  $ brew install llvm
+
+If you don't want to use Homebrew, you can download the a binary release of
+LLVM from `releases.llvm.org `__.
+Alongside ``bin/clangd`` you will need at least ``lib/clang/*/include``:
+
+.. code-block:: console
+
+  $ cp clang+llvm-7.0.0/bin/clangd /usr/local/bin/clangd
+  $ cp -r clang+llvm-7.0.0/lib/clang/ /usr/local/lib/
+
+:raw-html:``
+
+:raw-html:`Windows`
+
+Download and run the LLVM installer from `releases.llvm.org
+`__.
+
+:raw-html:``
+
+:raw-html:`Debian/Ubuntu`
+
+The ``clang-tools`` package usually contains an old version of clangd.
+
+Try to install the latest release (8.0):
+
+.. code-block:: console
+
+  $ sudo apt-get install clang-tools-8
+
+If that is not found, at least ``clang-tools-7`` should be available.
+
+The ``clangd`` executable will be installed as ``/usr/bin/clangd-8``. Make it
+the default ``clangd``:
+
+.. code-block:: console
+
+  $ sudo update-alternatives --install /usr/bin/clangd clangd /usr/bin/clangd-8 100
+
+:raw-html:``
+
+:raw-html:`Other systems`
+
+Most distributions include clangd in a ``clang-tools`` package, or in the full
+``llvm`` distribution.
+
+For some platforms, binaries are also avaliable at `releases.llvm.org
+`__.
+
+:raw-html:``
+
+Editor plugins
+==
+
+Language Server plugins are available for many editors. In principle, clangd
+should work with any of them, though the feature set and UI may vary.
+
+Here are some plugins we know work well with clangd.
+
+:raw-html:`YouCompleteMe for Vim`
+
+`YouCompleteMe `__ supports clangd.
+However, clangd support is not turned on by default, so you must install
+YouCompleteMe

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
gribozavr updated this revision to Diff 188536.
gribozavr added a comment.

Removed mentions of clangd v9.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710

Files:
  clang-tools-extra/docs/_static/clang-tools-extra-styles.css
  clang-tools-extra/docs/_templates/layout.html
  clang-tools-extra/docs/clangd/ApplyClangTidyFixInVSCode.gif
  clang-tools-extra/docs/clangd/ApplyFixInVSCode.gif
  clang-tools-extra/docs/clangd/CodeCompletionInEmacsCompanyMode.png
  clang-tools-extra/docs/clangd/CodeCompletionInSublimeText.png
  clang-tools-extra/docs/clangd/CodeCompletionInVSCode.png
  clang-tools-extra/docs/clangd/CodeCompletionInYCM.png
  
clang-tools-extra/docs/clangd/CodeCompletionInsertsNamespaceQualifiersInVSCode.gif
  clang-tools-extra/docs/clangd/DeveloperDocumentation.rst
  clang-tools-extra/docs/clangd/DiagnosticsInEmacsEglot.png
  clang-tools-extra/docs/clangd/ErrorsInVSCode.png
  clang-tools-extra/docs/clangd/Extensions.rst
  clang-tools-extra/docs/clangd/Features.rst
  clang-tools-extra/docs/clangd/FindAllReferencesInVSCode.gif
  clang-tools-extra/docs/clangd/FormatSelectionInVSCode.gif
  clang-tools-extra/docs/clangd/GoToDefinitionInVSCode.gif
  clang-tools-extra/docs/clangd/Installation.rst
  clang-tools-extra/docs/clangd/NavigationWithBreadcrumbsInVSCode.gif
  clang-tools-extra/docs/clangd/OutlineInVSCode.png
  clang-tools-extra/docs/clangd/SignatureHelpInVSCode.gif
  clang-tools-extra/docs/clangd/index.rst
  clang-tools-extra/docs/conf.py
  clang-tools-extra/docs/index.rst

Index: clang-tools-extra/docs/index.rst
===
--- clang-tools-extra/docs/index.rst
+++ clang-tools-extra/docs/index.rst
@@ -21,6 +21,7 @@
pp-trace
clang-rename
clangd/index
+   clangd/DeveloperDocumentation
clang-doc
 
 
Index: clang-tools-extra/docs/conf.py
===
--- clang-tools-extra/docs/conf.py
+++ clang-tools-extra/docs/conf.py
@@ -121,7 +121,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
Index: clang-tools-extra/docs/clangd/index.rst
===
--- clang-tools-extra/docs/clangd/index.rst
+++ clang-tools-extra/docs/clangd/index.rst
@@ -1,180 +1,27 @@
-
-Clangd
-
-
-.. contents::
+==
+clangd
+==
 
 .. toctree::
:maxdepth: 1
 
-:program:`Clangd` is an implementation of the `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 `_ 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 `_. :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
-`_ 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.
-

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Ilya Biryukov via Phabricator via cfe-commits 
ilya-biryukov accepted this revision.
ilya-biryukov added a comment.
This revision is now accepted and ready to land.

LGTM!


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
gribozavr updated this revision to Diff 188535.
gribozavr added a comment.

.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710

Files:
  clang-tools-extra/docs/_static/clang-tools-extra-styles.css
  clang-tools-extra/docs/_templates/layout.html
  clang-tools-extra/docs/clangd/ApplyClangTidyFixInVSCode.gif
  clang-tools-extra/docs/clangd/ApplyFixInVSCode.gif
  clang-tools-extra/docs/clangd/CodeCompletionInEmacsCompanyMode.png
  clang-tools-extra/docs/clangd/CodeCompletionInSublimeText.png
  clang-tools-extra/docs/clangd/CodeCompletionInVSCode.png
  clang-tools-extra/docs/clangd/CodeCompletionInYCM.png
  
clang-tools-extra/docs/clangd/CodeCompletionInsertsNamespaceQualifiersInVSCode.gif
  clang-tools-extra/docs/clangd/DeveloperDocumentation.rst
  clang-tools-extra/docs/clangd/DiagnosticsInEmacsEglot.png
  clang-tools-extra/docs/clangd/ErrorsInVSCode.png
  clang-tools-extra/docs/clangd/Extensions.rst
  clang-tools-extra/docs/clangd/Features.rst
  clang-tools-extra/docs/clangd/FindAllReferencesInVSCode.gif
  clang-tools-extra/docs/clangd/FormatSelectionInVSCode.gif
  clang-tools-extra/docs/clangd/GoToDefinitionInVSCode.gif
  clang-tools-extra/docs/clangd/Installation.rst
  clang-tools-extra/docs/clangd/NavigationWithBreadcrumbsInVSCode.gif
  clang-tools-extra/docs/clangd/OutlineInVSCode.png
  clang-tools-extra/docs/clangd/SignatureHelpInVSCode.gif
  clang-tools-extra/docs/clangd/index.rst
  clang-tools-extra/docs/conf.py
  clang-tools-extra/docs/index.rst

Index: clang-tools-extra/docs/index.rst
===
--- clang-tools-extra/docs/index.rst
+++ clang-tools-extra/docs/index.rst
@@ -21,6 +21,7 @@
pp-trace
clang-rename
clangd/index
+   clangd/DeveloperDocumentation
clang-doc
 
 
Index: clang-tools-extra/docs/conf.py
===
--- clang-tools-extra/docs/conf.py
+++ clang-tools-extra/docs/conf.py
@@ -121,7 +121,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
Index: clang-tools-extra/docs/clangd/index.rst
===
--- clang-tools-extra/docs/clangd/index.rst
+++ clang-tools-extra/docs/clangd/index.rst
@@ -1,180 +1,27 @@
-
-Clangd
-
-
-.. contents::
+==
+clangd
+==
 
 .. toctree::
:maxdepth: 1
 
-:program:`Clangd` is an implementation of the `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 `_ 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 `_. :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
-`_ 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

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
gribozavr updated this revision to Diff 188534.
gribozavr added a comment.

Separated user and developer documentation


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710

Files:
  clang-tools-extra/docs/_static/clang-tools-extra-styles.css
  clang-tools-extra/docs/_templates/layout.html
  clang-tools-extra/docs/clangd/ApplyClangTidyFixInVSCode.gif
  clang-tools-extra/docs/clangd/ApplyFixInVSCode.gif
  clang-tools-extra/docs/clangd/CodeCompletionInEmacsCompanyMode.png
  clang-tools-extra/docs/clangd/CodeCompletionInSublimeText.png
  clang-tools-extra/docs/clangd/CodeCompletionInVSCode.png
  clang-tools-extra/docs/clangd/CodeCompletionInYCM.png
  
clang-tools-extra/docs/clangd/CodeCompletionInsertsNamespaceQualifiersInVSCode.gif
  clang-tools-extra/docs/clangd/Compiling.rst
  clang-tools-extra/docs/clangd/Contributing.rst
  clang-tools-extra/docs/clangd/DeveloperDocumentation.rst
  clang-tools-extra/docs/clangd/DiagnosticsInEmacsEglot.png
  clang-tools-extra/docs/clangd/ErrorsInVSCode.png
  clang-tools-extra/docs/clangd/Extensions.rst
  clang-tools-extra/docs/clangd/Features.rst
  clang-tools-extra/docs/clangd/FindAllReferencesInVSCode.gif
  clang-tools-extra/docs/clangd/FormatSelectionInVSCode.gif
  clang-tools-extra/docs/clangd/GoToDefinitionInVSCode.gif
  clang-tools-extra/docs/clangd/Installation.rst
  clang-tools-extra/docs/clangd/NavigationWithBreadcrumbsInVSCode.gif
  clang-tools-extra/docs/clangd/OutlineInVSCode.png
  clang-tools-extra/docs/clangd/SignatureHelpInVSCode.gif
  clang-tools-extra/docs/clangd/index.rst
  clang-tools-extra/docs/conf.py
  clang-tools-extra/docs/index.rst

Index: clang-tools-extra/docs/index.rst
===
--- clang-tools-extra/docs/index.rst
+++ clang-tools-extra/docs/index.rst
@@ -21,6 +21,7 @@
pp-trace
clang-rename
clangd/index
+   clangd/DeveloperDocumentation
clang-doc
 
 
Index: clang-tools-extra/docs/conf.py
===
--- clang-tools-extra/docs/conf.py
+++ clang-tools-extra/docs/conf.py
@@ -121,7 +121,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
Index: clang-tools-extra/docs/clangd/index.rst
===
--- clang-tools-extra/docs/clangd/index.rst
+++ clang-tools-extra/docs/clangd/index.rst
@@ -1,180 +1,27 @@
-
-Clangd
-
-
-.. contents::
+==
+clangd
+==
 
 .. toctree::
:maxdepth: 1
 
-:program:`Clangd` is an implementation of the `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 `_ 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 `_. :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
-`_ 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

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Ilya Biryukov via Phabricator via cfe-commits 
ilya-biryukov added a comment.

It feels we have two groups of docs here, do you think it would be useful to 
split them more explicitly?
Specifically, we have:

1. User documentation
  - Getting started with clangd
  - Features
2. Developer documentation
  - Protocol extensions
  - Compiling clangd
  - Contributing to clangd

And the split is somewhat explicit right now


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Ilya Biryukov via Phabricator via cfe-commits 
ilya-biryukov added inline comments.



Comment at: clang-tools-extra/docs/clangd/Features.rst:41
+
+**(New in v9)**
+If a missing symbol was seen in a file you've edited recently, clangd will

It feels wrong to have announcements of the `9.0` features in the `8.0` release.
Maybe remove these. WDYT?


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
gribozavr updated this revision to Diff 188531.
gribozavr added a comment.
Herald added a reviewer: serge-sans-paille.

Added custom CSS for the details tag.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710

Files:
  clang-tools-extra/docs/_static/clang-tools-extra-styles.css
  clang-tools-extra/docs/_templates/layout.html
  clang-tools-extra/docs/clangd/ApplyClangTidyFixInVSCode.gif
  clang-tools-extra/docs/clangd/ApplyFixInVSCode.gif
  clang-tools-extra/docs/clangd/CodeCompletionInEmacsCompanyMode.png
  clang-tools-extra/docs/clangd/CodeCompletionInSublimeText.png
  clang-tools-extra/docs/clangd/CodeCompletionInVSCode.png
  clang-tools-extra/docs/clangd/CodeCompletionInYCM.png
  
clang-tools-extra/docs/clangd/CodeCompletionInsertsNamespaceQualifiersInVSCode.gif
  clang-tools-extra/docs/clangd/Compiling.rst
  clang-tools-extra/docs/clangd/Contributing.rst
  clang-tools-extra/docs/clangd/DiagnosticsInEmacsEglot.png
  clang-tools-extra/docs/clangd/ErrorsInVSCode.png
  clang-tools-extra/docs/clangd/Extensions.rst
  clang-tools-extra/docs/clangd/Features.rst
  clang-tools-extra/docs/clangd/FindAllReferencesInVSCode.gif
  clang-tools-extra/docs/clangd/FormatSelectionInVSCode.gif
  clang-tools-extra/docs/clangd/GoToDefinitionInVSCode.gif
  clang-tools-extra/docs/clangd/Installation.rst
  clang-tools-extra/docs/clangd/NavigationWithBreadcrumbsInVSCode.gif
  clang-tools-extra/docs/clangd/OutlineInVSCode.png
  clang-tools-extra/docs/clangd/SignatureHelpInVSCode.gif
  clang-tools-extra/docs/clangd/index.rst
  clang-tools-extra/docs/conf.py

Index: clang-tools-extra/docs/conf.py
===
--- clang-tools-extra/docs/conf.py
+++ clang-tools-extra/docs/conf.py
@@ -121,7 +121,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
Index: clang-tools-extra/docs/clangd/index.rst
===
--- clang-tools-extra/docs/clangd/index.rst
+++ clang-tools-extra/docs/clangd/index.rst
@@ -1,180 +1,30 @@
-
-Clangd
-
-
-.. contents::
+==
+clangd
+==
 
 .. toctree::
:maxdepth: 1
 
-:program:`Clangd` is an implementation of the `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 `_ 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 `_. :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
-`_ 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|

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
gribozavr updated this revision to Diff 188527.
gribozavr added a comment.

.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710

Files:
  clang-tools-extra/docs/clangd/ApplyClangTidyFixInVSCode.gif
  clang-tools-extra/docs/clangd/ApplyFixInVSCode.gif
  clang-tools-extra/docs/clangd/CodeCompletionInEmacsCompanyMode.png
  clang-tools-extra/docs/clangd/CodeCompletionInSublimeText.png
  clang-tools-extra/docs/clangd/CodeCompletionInVSCode.png
  clang-tools-extra/docs/clangd/CodeCompletionInYCM.png
  
clang-tools-extra/docs/clangd/CodeCompletionInsertsNamespaceQualifiersInVSCode.gif
  clang-tools-extra/docs/clangd/Compiling.rst
  clang-tools-extra/docs/clangd/Contributing.rst
  clang-tools-extra/docs/clangd/DiagnosticsInEmacsEglot.png
  clang-tools-extra/docs/clangd/ErrorsInVSCode.png
  clang-tools-extra/docs/clangd/Extensions.rst
  clang-tools-extra/docs/clangd/Features.rst
  clang-tools-extra/docs/clangd/FindAllReferencesInVSCode.gif
  clang-tools-extra/docs/clangd/FormatSelectionInVSCode.gif
  clang-tools-extra/docs/clangd/GoToDefinitionInVSCode.gif
  clang-tools-extra/docs/clangd/Installation.rst
  clang-tools-extra/docs/clangd/NavigationWithBreadcrumbsInVSCode.gif
  clang-tools-extra/docs/clangd/OutlineInVSCode.png
  clang-tools-extra/docs/clangd/SignatureHelpInVSCode.gif
  clang-tools-extra/docs/clangd/index.rst

Index: clang-tools-extra/docs/clangd/index.rst
===
--- clang-tools-extra/docs/clangd/index.rst
+++ clang-tools-extra/docs/clangd/index.rst
@@ -1,180 +1,30 @@
-
-Clangd
-
-
-.. contents::
+==
+clangd
+==
 
 .. toctree::
:maxdepth: 1
 
-:program:`Clangd` is an implementation of the `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 `_ 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 `_. :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
-`_ 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

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
gribozavr marked an inline comment as done.
gribozavr added inline comments.



Comment at: clang-tools-extra/docs/clangd/Installation.rst:360
+
+- Pass an experimental `-background-index` command line argument.  With
+  this feature enabled, clangd incrementally builds an index of projects

gribozavr wrote:
> ilya-biryukov wrote:
> > I'd avoid mentioning it at all, we didn't vet it for the 8 release (and I 
> > believe we landed critical fixes **after** the release cut).
> > We could add it back during `9.0` release.
> Removed in this patch (that I plan to cherry-pick into the 8.0 release 
> branch).  Will re-add in a separate patch, so that it goes into 9.0.
Reverted back after offline discussion.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
gribozavr marked 4 inline comments as done.
gribozavr added inline comments.



Comment at: clang-tools-extra/docs/clangd/Installation.rst:360
+
+- Pass an experimental `-background-index` command line argument.  With
+  this feature enabled, clangd incrementally builds an index of projects

ilya-biryukov wrote:
> I'd avoid mentioning it at all, we didn't vet it for the 8 release (and I 
> believe we landed critical fixes **after** the release cut).
> We could add it back during `9.0` release.
Removed in this patch (that I plan to cherry-pick into the 8.0 release branch). 
 Will re-add in a separate patch, so that it goes into 9.0.



Comment at: clang-tools-extra/docs/clangd/index.rst:20
 
-- Passing experimental `-background-index` commandline argument, which will
-  incrementally build an index of projects that you work on and make use of 
that
-  in clangd automatically.
-- Generate an index file using `clangd-indexer
-  
`_
-  Afterwards you can pass generated index file to clangd using
-  `-index-file=/path/to/index_file`.  *Note that clangd-indexer isn't included
-  alongside clangd in the standard clang-tools package. You will likely have to
-  build from source to use this option*
+clangd is an implementation of the `Language Server Protocol
+`__ and can work with

ilya-biryukov wrote:
> The original "clangd is a **language server**" looked somewhat better.
> Having a link to the LSP website is a good bet, though.
Reworded to add the phrase "language server".


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
gribozavr updated this revision to Diff 188521.
gribozavr marked 2 inline comments as done.
gribozavr added a comment.

Addressed review comments


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710

Files:
  clang-tools-extra/docs/clangd/ApplyClangTidyFixInVSCode.gif
  clang-tools-extra/docs/clangd/ApplyFixInVSCode.gif
  clang-tools-extra/docs/clangd/CodeCompletionInEmacsCompanyMode.png
  clang-tools-extra/docs/clangd/CodeCompletionInSublimeText.png
  clang-tools-extra/docs/clangd/CodeCompletionInVSCode.png
  clang-tools-extra/docs/clangd/CodeCompletionInYCM.png
  
clang-tools-extra/docs/clangd/CodeCompletionInsertsNamespaceQualifiersInVSCode.gif
  clang-tools-extra/docs/clangd/Compiling.rst
  clang-tools-extra/docs/clangd/Contributing.rst
  clang-tools-extra/docs/clangd/DiagnosticsInEmacsEglot.png
  clang-tools-extra/docs/clangd/ErrorsInVSCode.png
  clang-tools-extra/docs/clangd/Extensions.rst
  clang-tools-extra/docs/clangd/Features.rst
  clang-tools-extra/docs/clangd/FindAllReferencesInVSCode.gif
  clang-tools-extra/docs/clangd/FormatSelectionInVSCode.gif
  clang-tools-extra/docs/clangd/GoToDefinitionInVSCode.gif
  clang-tools-extra/docs/clangd/Installation.rst
  clang-tools-extra/docs/clangd/NavigationWithBreadcrumbsInVSCode.gif
  clang-tools-extra/docs/clangd/OutlineInVSCode.png
  clang-tools-extra/docs/clangd/SignatureHelpInVSCode.gif
  clang-tools-extra/docs/clangd/index.rst

Index: clang-tools-extra/docs/clangd/index.rst
===
--- clang-tools-extra/docs/clangd/index.rst
+++ clang-tools-extra/docs/clangd/index.rst
@@ -1,180 +1,30 @@
-
-Clangd
-
-
-.. contents::
+==
+clangd
+==
 
 .. toctree::
:maxdepth: 1
 
-:program:`Clangd` is an implementation of the `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 `_ 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 `_. :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
-`_ 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|

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Ilya Biryukov via Phabricator via cfe-commits 
ilya-biryukov added a reviewer: ioeric.
ilya-biryukov added a comment.

Still looking at it, a few quick notes.
Also added ioeric for an extra pair of eyes (it's a large change!).




Comment at: clang-tools-extra/docs/clangd/Installation.rst:360
+
+- Pass an experimental `-background-index` command line argument.  With
+  this feature enabled, clangd incrementally builds an index of projects

I'd avoid mentioning it at all, we didn't vet it for the 8 release (and I 
believe we landed critical fixes **after** the release cut).
We could add it back during `9.0` release.



Comment at: clang-tools-extra/docs/clangd/index.rst:20
 
-- Passing experimental `-background-index` commandline argument, which will
-  incrementally build an index of projects that you work on and make use of 
that
-  in clangd automatically.
-- Generate an index file using `clangd-indexer
-  
`_
-  Afterwards you can pass generated index file to clangd using
-  `-index-file=/path/to/index_file`.  *Note that clangd-indexer isn't included
-  alongside clangd in the standard clang-tools package. You will likely have to
-  build from source to use this option*
+clangd is an implementation of the `Language Server Protocol
+`__ and can work with

The original "clangd is a **language server**" looked somewhat better.
Having a link to the LSP website is a good bet, though.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58710/new/

https://reviews.llvm.org/D58710



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D58710: Added more detailed documentation for clangd

2019-02-27 Thread Dmitri Gribenko via Phabricator via cfe-commits 
gribozavr created this revision.
gribozavr added a reviewer: ilya-biryukov.
Herald added subscribers: cfe-commits, jdoerfert, kadircet, arphaman, jkorous, 
MaskRay, ioeric.
Herald added a project: clang.

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


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D58710

Files:
  clang-tools-extra/docs/clangd/ApplyClangTidyFixInVSCode.gif
  clang-tools-extra/docs/clangd/ApplyFixInVSCode.gif
  clang-tools-extra/docs/clangd/CodeCompletionInEmacsCompanyMode.png
  clang-tools-extra/docs/clangd/CodeCompletionInSublimeText.png
  clang-tools-extra/docs/clangd/CodeCompletionInVSCode.png
  clang-tools-extra/docs/clangd/CodeCompletionInYCM.png
  
clang-tools-extra/docs/clangd/CodeCompletionInsertsNamespaceQualifiersInVSCode.gif
  clang-tools-extra/docs/clangd/Compiling.rst
  clang-tools-extra/docs/clangd/Contributing.rst
  clang-tools-extra/docs/clangd/DiagnosticsInEmacsEglot.png
  clang-tools-extra/docs/clangd/ErrorsInVSCode.png
  clang-tools-extra/docs/clangd/Extensions.rst
  clang-tools-extra/docs/clangd/Features.rst
  clang-tools-extra/docs/clangd/FindAllReferencesInVSCode.gif
  clang-tools-extra/docs/clangd/FormatSelectionInVSCode.gif
  clang-tools-extra/docs/clangd/GoToDefinitionInVSCode.gif
  clang-tools-extra/docs/clangd/Installation.rst
  clang-tools-extra/docs/clangd/NavigationWithBreadcrumbsInVSCode.gif
  clang-tools-extra/docs/clangd/OutlineInVSCode.png
  clang-tools-extra/docs/clangd/SignatureHelpInVSCode.gif
  clang-tools-extra/docs/clangd/index.rst

Index: clang-tools-extra/docs/clangd/index.rst
===
--- clang-tools-extra/docs/clangd/index.rst
+++ clang-tools-extra/docs/clangd/index.rst
@@ -1,180 +1,30 @@
-
-Clangd
-
-
-.. contents::
+==
+clangd
+==
 
 .. toctree::
:maxdepth: 1
 
-:program:`Clangd` is an implementation of the `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 `_ 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 `_. :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
-`_ 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|
-+-++--+
-|