[PATCH] D31887: [clangd] Add documentation page

[Krasimir Georgiev via Phabricator via cfe-commits]

krasimir accepted this revision.
krasimir added a comment.
This revision is now accepted and ready to land.

Looks good! Thank you!


https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Marc-Andre Laperle via Phabricator via cfe-commits]

malaperle-ericsson added a comment.

In https://reviews.llvm.org/D31887#740747, @Prazek wrote:

> In https://reviews.llvm.org/D31887#740727, @malaperle-ericsson wrote:
>
> > Would it be possible to commit this? I do not have commit rights. Thanks!
>
>
> Why won't you get commit right? You will probably make some other 
> contribution to clangd, so it will be handy to have it :)


I wasn't sure at what moment it was appropriate to ask for commit rights. I 
just sent the request for it :)


https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Piotr Padlewski via Phabricator via cfe-commits]

Prazek added a comment.

In https://reviews.llvm.org/D31887#740727, @malaperle-ericsson wrote:

> Would it be possible to commit this? I do not have commit rights. Thanks!


Why won't you get commit right? You will probably make some other contribution 
to clangd, so it will be handy to have it :)


https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Marc-Andre Laperle via Phabricator via cfe-commits]

malaperle-ericsson added a comment.

Would it be possible to commit this? I do not have commit rights. Thanks!


https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Jonas Devlieghere via Phabricator via cfe-commits]

JDevlieghere added a comment.

Looks good, nothing to add from my side.


https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Marc-Andre Laperle via Phabricator via cfe-commits]

malaperle-ericsson added a comment.

Ping. Any more objections?


https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Marc-Andre Laperle via Phabricator via cfe-commits]

malaperle-ericsson updated this revision to Diff 95416.
malaperle-ericsson removed a subscriber: Sarcasm.
malaperle-ericsson added a comment.

Update with comments (extra backticks, etc)


https://reviews.llvm.org/D31887

Files:
  docs/clangd.rst
  docs/index.rst

Index: docs/index.rst
===
--- docs/index.rst
+++ docs/index.rst
@@ -25,6 +25,7 @@
modularize
pp-trace
clang-rename
+   clangd
 
 
 Doxygen Documentation
Index: docs/clangd.rst
===
--- /dev/null
+++ docs/clangd.rst
@@ -0,0 +1,106 @@
+
+Clangd
+
+
+.. contents::
+
+.. 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 `building Clangd`_, then open Visual
+Studio Code in the clangd-vscode folder and launch the extension.
+
+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`.
+
++-++--+
+| C/C++ Editor feature|  LSP   |  Clangd  |
++=++==+
+| Formatting  | Yes|   Yes|
++-++--+
+| Completion  | Yes|   Yes|
++-++--+
+| Diagnostics | Yes|   Yes|
++-++--+ 
+| Fix-its | Yes|   Yes|
++-++--+
+| Go to Definition| Yes|   No |
++-++--+
+| Source hover| Yes|   No |
++-++--+
+| Signature Help  | Yes|   No |
++-++--+
+| Find References | Yes|   No |
++-++--+
+| Document Highlights | Yes|   No |
++-++--+
+| Rename  | Yes|   No |
++-++--+
+| Code Lens   | Yes|   No |
++-++--+
+| 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 |
++

[PATCH] D31887: [clangd] Add documentation page

[Jonas Devlieghere via Phabricator via cfe-commits]

JDevlieghere added a comment.

Great to see this coming along!




Comment at: docs/clangd.rst:10
+
+: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.

s/clangd/Clangd



Comment at: docs/clangd.rst:10
+
+: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.

JDevlieghere wrote:
> s/clangd/Clangd
Reflow text to 80 columns



Comment at: docs/clangd.rst:20
+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

Spurious backticks



Comment at: docs/clangd.rst:22
+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.

Spurious backtick



Comment at: docs/clangd.rst:33
+
+Many features could be implemented in :program:`Clangd``.
+Here is a list of features that could be useful with the status of whether or

Spurious backtick



Comment at: docs/clangd.rst:35
+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

Spurious backtick



Comment at: docs/clangd.rst:37
+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``.
+

Spurious backtick



Comment at: docs/clangd.rst:91
+A good place for interested contributors is the `Clang developer mailing list 
`_.
+If you're also interested in contributing patches to Clangd, take a look at the
+`LLVM Developer Policy `_ and `Code 
Reviews `_ page.

:program:`Clangd` 



Comment at: docs/clangd.rst:94
+Contributions of new features to the `Language Server Protocol 
`_ itself would also be 
very useful,
+so that Clangd can eventually implement them in a conforming way.

:program:`Clangd` 


https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Marc-Andre Laperle via Phabricator via cfe-commits]

malaperle-ericsson updated this revision to Diff 95078.
malaperle-ericsson added a comment.

Fix mention of "extra Clang tools"


https://reviews.llvm.org/D31887

Files:
  docs/clangd.rst
  docs/index.rst

Index: docs/index.rst
===
--- docs/index.rst
+++ docs/index.rst
@@ -25,6 +25,7 @@
modularize
pp-trace
clang-rename
+   clangd
 
 
 Doxygen Documentation
Index: docs/clangd.rst
===
--- /dev/null
+++ docs/clangd.rst
@@ -0,0 +1,94 @@
+
+Clangd
+
+
+.. contents::
+
+.. 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 `building Clangd`_,
+then open Visual Studio Code in the clangd-vscode folder and launch the extension.
+
+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``.
+
++-++--+
+| C/C++ Editor feature|  LSP   |  Clangd  |
++=++==+
+| Formatting  | Yes|   Yes|
++-++--+
+| Completion  | Yes|   Yes|
++-++--+
+| Diagnostics | Yes|   Yes|
++-++--+ 
+| Fix-its | Yes|   Yes|
++-++--+
+| Go to Definition| Yes|   No |
++-++--+
+| Source hover| Yes|   No |
++-++--+
+| Signature Help  | Yes|   No |
++-++--+
+| Find References | Yes|   No |
++-++--+
+| Document Highlights | Yes|   No |
++-++--+
+| Rename  | Yes|   No |
++-++--+
+| Code Lens   | Yes|   No |
++-++--+
+| 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

[PATCH] D31887: [clangd] Add documentation page

[Matthias Gehre via Phabricator via cfe-commits]

mgehre added inline comments.



Comment at: docs/clangd.rst:28
+
+You can follow the instructions for `building Clang 
`_ but "extra Clang Tool" is **not** 
optional.
+

In the reference, it is called "extra Clang tools".


https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Marc-Andre Laperle via Phabricator via cfe-commits]

malaperle-ericsson added a comment.

Sorry about all the typos. I have now installed a spell checked in VS Code :)


https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Marc-Andre Laperle via Phabricator via cfe-commits]

malaperle-ericsson updated this revision to Diff 94815.
malaperle-ericsson marked 6 inline comments as done.
malaperle-ericsson added a comment.

Fixed typos and other comments.


https://reviews.llvm.org/D31887

Files:
  docs/clangd.rst
  docs/index.rst

Index: docs/index.rst
===
--- docs/index.rst
+++ docs/index.rst
@@ -25,6 +25,7 @@
modularize
pp-trace
clang-rename
+   clangd
 
 
 Doxygen Documentation
Index: docs/clangd.rst
===
--- /dev/null
+++ docs/clangd.rst
@@ -0,0 +1,94 @@
+
+Clangd
+
+
+.. contents::
+
+.. 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 `building Clangd`_,
+then open Visual Studio Code in the clangd-vscode folder and launch the extension.
+
+Building Clangd
+==
+
+You can follow the instructions for `building Clang `_ but "extra Clang Tool" 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``.
+
++-++--+
+| C/C++ Editor feature|  LSP   |  Clangd  |
++=++==+
+| Formatting  | Yes|   Yes|
++-++--+
+| Completion  | Yes|   Yes|
++-++--+
+| Diagnostics | Yes|   Yes|
++-++--+ 
+| Fix-its | Yes|   Yes|
++-++--+
+| Go to Definition| Yes|   No |
++-++--+
+| Source hover| Yes|   No |
++-++--+
+| Signature Help  | Yes|   No |
++-++--+
+| Find References | Yes|   No |
++-++--+
+| Document Highlights | Yes|   No |
++-++--+
+| Rename  | Yes|   No |
++-++--+
+| Code Lens   | Yes|   No |
++-++--+
+| 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 |
++

[PATCH] D31887: [clangd] Add documentation page

[Jonas Toth via Phabricator via cfe-commits]

JonasToth added inline comments.



Comment at: docs/clangd.rst:16
+
+Clangd is not meant to be used by C/C++ developpers directly but rather from a 
client implementing the protocol.
+A client would be typically implemented in an IDE or an editor.

kromanenkov wrote:
> s/developpers/developers
maybe there should be special highlighting to Clangd here and elsewhere?



Comment at: docs/clangd.rst:23
+in trying Clangd in combination with Visual Studio Code, you can start by 
`building Clangd`_,
+then you can open Visual Studio Code in the clangd-vscode folder and launch 
the extension.
+

maybe remove the `you can`. The sentence is still valid without the repetition.


Repository:
  rL LLVM

https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Kirill Romanenkov via Phabricator via cfe-commits]

kromanenkov added inline comments.



Comment at: docs/clangd.rst:10
+
+:program:`clangd` is an implementation of the `Languge 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.

s/Languge/Language



Comment at: docs/clangd.rst:16
+
+Clangd is not meant to be used by C/C++ developpers directly but rather from a 
client implementing the protocol.
+A client would be typically implemented in an IDE or an editor.

s/developpers/developers



Comment at: docs/clangd.rst:34
+Many features could be implemented in Clangd.
+Here is a list of features that could be useful with the satus of whether or
+not they are already implemented in Clangd and specified in the Language 
Server Protocol.

s/satus/status



Comment at: docs/clangd.rst:93
+`LLVM Developer Policy `_ and `Code 
Reviews `_ page.
+Contributions of new features to the `Languge Server Protocol 
`_ itself would also be 
very useful,
+so that Clangd can eventually implement them in a conforming way.

s/Languge/Language


Repository:
  rL LLVM

https://reviews.llvm.org/D31887



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

[PATCH] D31887: [clangd] Add documentation page

[Gábor Horváth via Phabricator via cfe-commits]

xazax.hun added a comment.

Maybe this is a good time to decide ClangD, Clangd, or clangd is the correct 
capitalization.


Repository:
  rL LLVM

https://reviews.llvm.org/D31887



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