[clang-tools-extra] a909a84 - [clang-tidy] Improve documentation on Clangd integration
Kirill Bobyrev via cfe-commits
cfe-commits at lists.llvm.org
Wed Sep 16 03:10:15 PDT 2020
Author: Kirill Bobyrev
Date: 2020-09-16T12:10:00+02:00
New Revision: a909a84ef2d9220242512b8be1206ee3d9b3d8b9
URL: https://github.com/llvm/llvm-project/commit/a909a84ef2d9220242512b8be1206ee3d9b3d8b9
DIFF: https://github.com/llvm/llvm-project/commit/a909a84ef2d9220242512b8be1206ee3d9b3d8b9.diff
LOG: [clang-tidy] Improve documentation on Clangd integration
The integration is already complete; this patch updates information as well as
suggests using Clang-Tidy via Clangd integration that is vastly available
in most editors through LSP client plugins.
Reviewed By: hokein
Differential Revision: https://reviews.llvm.org/D87686
Added:
Modified:
clang-tools-extra/docs/clang-tidy/Integrations.rst
Removed:
################################################################################
diff --git a/clang-tools-extra/docs/clang-tidy/Integrations.rst b/clang-tools-extra/docs/clang-tidy/Integrations.rst
index bdd012aec89e..94851631fe1f 100644
--- a/clang-tools-extra/docs/clang-tidy/Integrations.rst
+++ b/clang-tools-extra/docs/clang-tidy/Integrations.rst
@@ -2,12 +2,17 @@
Clang-tidy IDE/Editor Integrations
==================================
-.. _Clangd: https://clang.llvm.org/extra/clangd.html
+.. _clangd: http://clangd.llvm.org/
+.. _is available: https://clangd.llvm.org/installation.html#editor-plugins
+.. _more: https://langserver.org/#implementations-client
Apart from being a standalone tool, :program:`clang-tidy` is integrated into
-various IDEs, code analyzers, and editors. Besides, it is currently being
-integrated into Clangd_. The following table shows the most
-well-known :program:`clang-tidy` integrations in detail.
+various IDEs, code analyzers, and editors. We recommend using clangd_ which
+integrates :program:`clang-tidy` and `is available`_ in most major editors
+through plugins (Vim, Emacs, Visual Studio Code, Sublime Text and more_).
+
+The following table shows the most well-known :program:`clang-tidy`
+integrations in detail.
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
| | Feature |
@@ -17,8 +22,8 @@ well-known :program:`clang-tidy` integrations in detail.
|A.L.E. for Vim | \+\ | \-\ | \-\ | \-\ | \+\ |
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
|Clang Power Tools for Visual Studio | \-\ | \+\ | \-\ | \+\ | \-\ |
-+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
-|Clangd | \+\ | \-\ | \-\ | \-\ | \-\ |
++-------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
+|Clangd | \+\ | \-\ | \-\ | \+\ | \-\ |
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
|CLion IDE | \+\ | \+\ | \+\ | \+\ | \+\ |
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
More information about the cfe-commits
mailing list