This is an archive of the discontinued LLVM Phabricator instance.

Differential D87686

[clang-tidy] Improve documentation on Clangd integration
ClosedPublic

Authored by kbobyrev on Sep 15 2020, 4:50 AM.

Details

Reviewers
hokein
Commits
rGa909a84ef2d9: [clang-tidy] Improve documentation on Clangd integration
Summary

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.

Diff Detail

Event Timeline

kbobyrev created this revision.Sep 15 2020, 4:50 AM
Herald added a project: Restricted Project. · View Herald TranscriptSep 15 2020, 4:50 AM
Herald added subscribers: cfe-commits, usaxena95, arphaman and 2 others. · View Herald Transcript
kbobyrev requested review of this revision.Sep 15 2020, 4:51 AM
Herald added subscribers: MaskRay, ilya-biryukov. · View Herald TranscriptSep 15 2020, 4:51 AM
Harbormaster completed remote builds in B71718: Diff 291866.Sep 15 2020, 5:18 AM
hokein added inline comments.Sep 15 2020, 7:06 AM
clang-tools-extra/docs/clang-tidy/Integrations.rst
5–7

nit: update to the official website http://clangd.llvm.org/

22

hmm, I know the purpose, but the table is sorted by the name, I think we should not change it.

btw .clang-tidy is supported now, we can change - to +.

sammccall added a comment.Sep 16 2020, 1:22 AM

Thanks for doing this! (Agree with Haojian's comments too)

clang-tools-extra/docs/clang-tidy/Integrations.rst
10–15

nit: lowercase C for clangd

kbobyrev updated this revision to Diff 292149.Sep 16 2020, 2:06 AM
kbobyrev marked 3 inline comments as done.

Address review comments.

hokein accepted this revision.Sep 16 2020, 3:06 AM

thanks!

This revision is now accepted and ready to land.Sep 16 2020, 3:06 AM
This revision was landed with ongoing or failed builds.Sep 16 2020, 3:10 AM
Closed by commit rGa909a84ef2d9: [clang-tidy] Improve documentation on Clangd integration (authored by kbobyrev). · Explain Why
This revision was automatically updated to reflect the committed changes.
kbobyrev added a commit: rGa909a84ef2d9: [clang-tidy] Improve documentation on Clangd integration.
Harbormaster completed remote builds in B71848: Diff 292149.Sep 16 2020, 3:18 AM
kbobyrev mentioned this in rG3e5a4ef51a1d: Fix table formatting after D87686.Sep 16 2020, 3:28 AM

Revision Contents

PathSize
clang-tools-extra/
docs/
clang-tidy/
17 lines

Diff 292161

clang-tools-extra/docs/clang-tidy/Integrations.rst

================================== ==================================
Clang-tidy IDE/Editor Integrations 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
hokeinUnsubmitted
Done
ReplyInline Actions

nit: update to the official website http://clangd.llvm.org/

hokein: nit: update to the official website http://clangd.llvm.org/
Apart from being a standalone tool, :program:`clang-tidy` is integrated into Apart from being a standalone tool, :program:`clang-tidy` is integrated into
various IDEs, code analyzers, and editors. Besides, it is currently being various IDEs, code analyzers, and editors. We recommend using clangd_ which
integrated into Clangd_. The following table shows the most integrates :program:`clang-tidy` and `is available`_ in most major editors
well-known :program:`clang-tidy` integrations in detail. 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.
sammccallUnsubmitted
Done
ReplyInline Actions

nit: lowercase C for clangd

sammccall: nit: lowercase C for clangd
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+ +--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
| | Feature | | | Feature |
+======================================+========================+=================================+==========================+=========================================+==========================+ +======================================+========================+=================================+==========================+=========================================+==========================+
| **Tool** | On-the-fly inspection | Check list configuration (GUI) | Options to checks (GUI) | Configuration via ``.clang-tidy`` files | Custom clang-tidy binary | | **Tool** | On-the-fly inspection | Check list configuration (GUI) | Options to checks (GUI) | Configuration via ``.clang-tidy`` files | Custom clang-tidy binary |
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+ +--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
|A.L.E. for Vim | \+\ | \-\ | \-\ | \-\ | \+\ | |A.L.E. for Vim | \+\ | \-\ | \-\ | \-\ | \+\ |
hokeinUnsubmitted
Done
ReplyInline Actions

hmm, I know the purpose, but the table is sorted by the name, I think we should not change it.

btw .clang-tidy is supported now, we can change - to +.

hokein: hmm, I know the purpose, but the table is sorted by the name, I think we should not change it.
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+ +--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
|Clang Power Tools for Visual Studio | \-\ | \+\ | \-\ | \+\ | \-\ | |Clang Power Tools for Visual Studio | \-\ | \+\ | \-\ | \+\ | \-\ |
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+ +-------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
|Clangd | \+\ | \-\ | \-\ | \-\ | \-\ | |Clangd | \+\ | \-\ | \-\ | \+\ | \-\ |
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+ +--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
|CLion IDE | \+\ | \+\ | \+\ | \+\ | \+\ | |CLion IDE | \+\ | \+\ | \+\ | \+\ | \+\ |
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+ +--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
|CodeChecker | \-\ | \-\ | \-\ | \-\ | \+\ | |CodeChecker | \-\ | \-\ | \-\ | \-\ | \+\ |
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+ +--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
|CPPCheck | \-\ | \-\ | \-\ | \-\ | \-\ | |CPPCheck | \-\ | \-\ | \-\ | \-\ | \-\ |
+--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+ +--------------------------------------+------------------------+---------------------------------+--------------------------+-----------------------------------------+--------------------------+
|CPPDepend | \-\ | \-\ | \-\ | \-\ | \-\ | |CPPDepend | \-\ | \-\ | \-\ | \-\ | \-\ |
▲ Show 20 Lines • Show All 90 Lines • Show Last 20 Lines