[clang-tidy] Contributing.rst update snippet and docs

[Marcondiro]

This reflects the add_new_check.py changes: isLanguageVersionSupported is now overridden by default by the script

The changes were instroduced in #100129

Thanks

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-clang-tools-extra

Author: Marco C. (Marcondiro)

Changes

This reflects the add_new_check.py changes: isLanguageVersionSupported is now overridden by default by the script

The changes were instroduced in #100129

Thanks

---

Full diff: https://github.com/llvm/llvm-project/pull/129209.diff

1 Files Affected:

• (modified) clang-tools-extra/docs/clang-tidy/Contributing.rst (+9-9)

diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst
index 4f1df8d114444..ed28df0e9887a 100644
--- a/clang-tools-extra/docs/clang-tidy/Contributing.rst
+++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst
@@ -171,9 +171,7 @@ Let's see in more detail at the check class definition:
 
   #include "../ClangTidyCheck.h"
 
-  namespace clang {
-  namespace tidy {
-  namespace readability {
+  namespace clang::tidy::readability {
 
   ...
   class AwesomeFunctionNamesCheck : public ClangTidyCheck {
@@ -182,11 +180,12 @@ Let's see in more detail at the check class definition:
         : ClangTidyCheck(Name, Context) {}
     void registerMatchers(ast_matchers::MatchFinder *Finder) override;
     void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+    bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
+      return LangOpts.CPlusPlus;
+    }
   };
 
-  } // namespace readability
-  } // namespace tidy
-  } // namespace clang
+  } // namespace clang::tidy::readability
 
   ...
 
@@ -203,6 +202,10 @@ for more information) that will find the pattern in the AST that we want to
 inspect. The results of the matching are passed to the ``check`` method, which
 can further inspect them and report diagnostics.
 
+By default, the new check applies only to C++ code. If it should apply under 
+different language options, be sure to update the ``isLanguageVersionSupported``
+method accordingly.
+
 .. code-block:: c++
 
   using namespace ast_matchers;
@@ -231,9 +234,6 @@ override the method ``registerPPCallbacks``.  The ``add_new_check.py`` script
 does not generate an override for this method in the starting point for your
 new check.
 
-If your check applies only under a specific set of language options, be sure
-to override the method ``isLanguageVersionSupported`` to reflect that.
-
 Check development tips
 ----------------------
 

[llvmbot]

@llvm/pr-subscribers-clang-tidy

Author: Marco C. (Marcondiro)

Changes

This reflects the add_new_check.py changes: isLanguageVersionSupported is now overridden by default by the script

The changes were instroduced in #100129

Thanks

---

Full diff: https://github.com/llvm/llvm-project/pull/129209.diff

1 Files Affected:

• (modified) clang-tools-extra/docs/clang-tidy/Contributing.rst (+9-9)

diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst
index 4f1df8d114444..ed28df0e9887a 100644
--- a/clang-tools-extra/docs/clang-tidy/Contributing.rst
+++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst
@@ -171,9 +171,7 @@ Let's see in more detail at the check class definition:
 
   #include "../ClangTidyCheck.h"
 
-  namespace clang {
-  namespace tidy {
-  namespace readability {
+  namespace clang::tidy::readability {
 
   ...
   class AwesomeFunctionNamesCheck : public ClangTidyCheck {
@@ -182,11 +180,12 @@ Let's see in more detail at the check class definition:
         : ClangTidyCheck(Name, Context) {}
     void registerMatchers(ast_matchers::MatchFinder *Finder) override;
     void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+    bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
+      return LangOpts.CPlusPlus;
+    }
   };
 
-  } // namespace readability
-  } // namespace tidy
-  } // namespace clang
+  } // namespace clang::tidy::readability
 
   ...
 
@@ -203,6 +202,10 @@ for more information) that will find the pattern in the AST that we want to
 inspect. The results of the matching are passed to the ``check`` method, which
 can further inspect them and report diagnostics.
 
+By default, the new check applies only to C++ code. If it should apply under 
+different language options, be sure to update the ``isLanguageVersionSupported``
+method accordingly.
+
 .. code-block:: c++
 
   using namespace ast_matchers;
@@ -231,9 +234,6 @@ override the method ``registerPPCallbacks``.  The ``add_new_check.py`` script
 does not generate an override for this method in the starting point for your
 new check.
 
-If your check applies only under a specific set of language options, be sure
-to override the method ``isLanguageVersionSupported`` to reflect that.
-
 Check development tips
 ----------------------
 

[carlosgalvezp]

Would it be better to document that one can specify the language when running add_new_check.py --language? Possibly earlier in this document when it describes what this script does.

[Marcondiro]

Yes, good point, fixed

[carlosgalvezp]

LGTM, thank you!

[Marcondiro]

@carlosgalvezp I do not have the ability to merge the PR, could you do it? thanks!

[carlosgalvezp]

Sure, will do once the CI checks are done! :)

[github-actions]

@Marcondiro Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!