[PATCH] D87686: [clang-tidy] Improve documentation on Clangd integration
This revision was landed with ongoing or failed builds. This revision was automatically updated to reflect the committed changes. Closed by commit rGa909a84ef2d9: [clang-tidy] Improve documentation on Clangd integration (authored by kbobyrev). Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D87686/new/ https://reviews.llvm.org/D87686 Files: clang-tools-extra/docs/clang-tidy/Integrations.rst Index: clang-tools-extra/docs/clang-tidy/Integrations.rst === --- clang-tools-extra/docs/clang-tidy/Integrations.rst +++ 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 @@ |A.L.E. for Vim| \+\| \-\ | \-\| \-\ | \+\| +--++-+--+-+--+ |Clang Power Tools for Visual Studio | \-\| \+\ | \-\| \+\ | \-\| -+--++-+--+-+--+ -|Clangd| \+\| \-\ | \-\| \-\ | \-\| ++-++-+--+-+--+ +|Clangd| \+\| \-\ | \-\| \+\ | \-\| +--++-+--+-+--+ |CLion IDE | \+\| \+\ | \+\| \+\ | \+\| +--++-+--+-+--+ Index: clang-tools-extra/docs/clang-tidy/Integrations.rst === --- clang-tools-extra/docs/clang-tidy/Integrations.rst +++ 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
[PATCH] D87686: [clang-tidy] Improve documentation on Clangd integration
hokein accepted this revision. hokein added a comment. This revision is now accepted and ready to land. thanks! Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D87686/new/ https://reviews.llvm.org/D87686 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D87686: [clang-tidy] Improve documentation on Clangd integration
kbobyrev updated this revision to Diff 292149. kbobyrev marked 3 inline comments as done. kbobyrev added a comment. Address review comments. Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D87686/new/ https://reviews.llvm.org/D87686 Files: clang-tools-extra/docs/clang-tidy/Integrations.rst Index: clang-tools-extra/docs/clang-tidy/Integrations.rst === --- clang-tools-extra/docs/clang-tidy/Integrations.rst +++ 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 @@ |A.L.E. for Vim| \+\| \-\ | \-\| \-\ | \+\| +--++-+--+-+--+ |Clang Power Tools for Visual Studio | \-\| \+\ | \-\| \+\ | \-\| -+--++-+--+-+--+ -|Clangd| \+\| \-\ | \-\| \-\ | \-\| ++-++-+--+-+--+ +|Clangd| \+\| \-\ | \-\| \+\ | \-\| +--++-+--+-+--+ |CLion IDE | \+\| \+\ | \+\| \+\ | \+\| +--++-+--+-+--+ Index: clang-tools-extra/docs/clang-tidy/Integrations.rst === --- clang-tools-extra/docs/clang-tidy/Integrations.rst +++ 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
[PATCH] D87686: [clang-tidy] Improve documentation on Clangd integration
sammccall added a comment. Thanks for doing this! (Agree with Haojian's comments too) Comment at: clang-tools-extra/docs/clang-tidy/Integrations.rst:10 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 nit: lowercase C for clangd Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D87686/new/ https://reviews.llvm.org/D87686 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D87686: [clang-tidy] Improve documentation on Clangd integration
hokein added inline comments. Comment at: clang-tools-extra/docs/clang-tidy/Integrations.rst:5 .. _Clangd: https://clang.llvm.org/extra/clangd.html +.. _is available: https://clangd.llvm.org/installation.html#editor-plugins nit: update to the official website http://clangd.llvm.org/ Comment at: clang-tools-extra/docs/clang-tidy/Integrations.rst:22 +--++-+--+-+--+ +|Clangd| \+\| \-\ | \-\| \-\ | \-\| ++--++-+--+-+--+ 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 `+`. Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D87686/new/ https://reviews.llvm.org/D87686 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D87686: [clang-tidy] Improve documentation on Clangd integration
kbobyrev created this revision. kbobyrev added a reviewer: hokein. Herald added subscribers: cfe-commits, usaxena95, arphaman, jkorous, xazax.hun. Herald added a project: clang. kbobyrev requested review of this revision. Herald added subscribers: MaskRay, ilya-biryukov. 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. Repository: rG LLVM Github Monorepo https://reviews.llvm.org/D87686 Files: clang-tools-extra/docs/clang-tidy/Integrations.rst Index: clang-tools-extra/docs/clang-tidy/Integrations.rst === --- clang-tools-extra/docs/clang-tidy/Integrations.rst +++ clang-tools-extra/docs/clang-tidy/Integrations.rst @@ -3,23 +3,28 @@ == .. _Clangd: https://clang.llvm.org/extra/clangd.html +.. _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 | +==++=+==+=+==+ | **Tool**| On-the-fly inspection | Check list configuration (GUI) | Options to checks (GUI) | Configuration via ``.clang-tidy`` files | Custom clang-tidy binary | +--++-+--+-+--+ +|Clangd| \+\| \-\ | \-\| \-\ | \-\| ++--++-+--+-+--+ |A.L.E. for Vim| \+\| \-\ | \-\| \-\ | \+\| +--++-+--+-+--+ |Clang Power Tools for Visual Studio | \-\| \+\ | \-\| \+\ | \-\| +--++-+--+-+--+ -|Clangd| \+\| \-\ | \-\| \-\ | \-\| -+--++-+--+-+--+ |CLion IDE | \+\| \+\ | \+\| \+\ | \+\| +--++-+--+-+--+ |CodeChecker | \-\| \-\ | \-\| \-\ | \+\| Index: clang-tools-extra/docs/clang-tidy/Integrations.rst === ---
