llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT--> @llvm/pr-subscribers-clang-tools-extra Author: None (MichelleCDjunaidi) <details> <summary>Changes</summary> Motivation: Clang has a page where they list out external examples: https://clang.llvm.org/docs/ExternalClangExamples.html. While I was writing an out-of-tree clang-tidy plugin, I wanted such a page to exist also as it would have helped development. The example repo listed in the proposed page has been useful for me. --- Full diff: https://github.com/llvm/llvm-project/pull/106675.diff 1 Files Affected: - (added) clang-tools-extra/docs/clang-tidy/ExternalClang-TidyExamples.rst (+31) ``````````diff diff --git a/clang-tools-extra/docs/clang-tidy/ExternalClang-TidyExamples.rst b/clang-tools-extra/docs/clang-tidy/ExternalClang-TidyExamples.rst new file mode 100644 index 00000000000000..735f99b30c7b7d --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/ExternalClang-TidyExamples.rst @@ -0,0 +1,31 @@ +======================= +External Clang-Tidy Examples +======================= + +Introduction +============ + +This page provides examples of what people have done with clang-tidy that +might serve as useful guides (or starting points) to develop your own checks. +They may be helpful even for necessary things such as how to write CMakeLists.txt +for an out-of-tree plugin of clang-tidy checks. + +If you know of (or wrote!) a tool or project using clang-tidy, please post on +`the Discourse forums (Clang Frontend category) +<https://discourse.llvm.org/c/clang/6>`_ to have it added. +(or if you are already a clang-tidy contributor, feel free to directly commit +additions). Since the primary purpose of this page is to provide examples +that can help developers, generally they must have code available. + +As clang-tidy shares C++ AST Matchers with Clang diagnostics, `External Clang Examples`_ +may also be useful to look at. + +.. _External Clang Examples: https://clang.llvm.org/docs/ExternalClangExamples.html + +https://clang.llvm.org/docs/ExternalClangExamples.html + +List of projects and tools +========================== + +`<https://github.com/coveooss/clang-tidy-plugin-examples/tree/main>`_ + "This folder contains clang-tidy plugins." \ No newline at end of file `````````` </details> https://github.com/llvm/llvm-project/pull/106675 _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
