Skip to content

[clang-tidy-diff] Add an option to treat warnings as errors #128221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 17, 2025

Conversation

juru1234
Copy link
Contributor

This patch allows to treat warnings as erros using clang-tidy-diff.

Copy link

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
Copy link
Member

llvmbot commented Feb 21, 2025

@llvm/pr-subscribers-clang-tidy

Author: Julian (juru1234)

Changes

This patch allows to treat warnings as erros using clang-tidy-diff.


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

1 Files Affected:

  • (modified) clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py (+9)
diff --git a/clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py b/clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py
index 33de2077dfb1a..863b504539b58 100755
--- a/clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py
+++ b/clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py
@@ -259,6 +259,12 @@ def main():
         action="store_true",
         help="Only check files in the compilation database",
     )
+    parser.add_argument(
+        "-warnings-as-errors",
+        help="Upgrades clang-tidy warnings to errors. Same format as '-checks'.",
+        default="",
+    )
+
 
     clang_tidy_args = []
     argv = sys.argv[1:]
@@ -374,6 +380,9 @@ def main():
         common_clang_tidy_args.append("-extra-arg-before=%s" % arg)
     for plugin in args.plugins:
         common_clang_tidy_args.append("-load=%s" % plugin)
+    if args.warnings_as_errors != "":
+        common_clang_tidy_args.append("-warnings-as-errors=" + args.warnings_as_errors)
+
 
     for name in lines_by_file:
         line_filter_json = json.dumps(

@llvmbot
Copy link
Member

llvmbot commented Feb 21, 2025

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

Author: Julian (juru1234)

Changes

This patch allows to treat warnings as erros using clang-tidy-diff.


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

1 Files Affected:

  • (modified) clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py (+9)
diff --git a/clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py b/clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py
index 33de2077dfb1a..863b504539b58 100755
--- a/clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py
+++ b/clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py
@@ -259,6 +259,12 @@ def main():
         action="store_true",
         help="Only check files in the compilation database",
     )
+    parser.add_argument(
+        "-warnings-as-errors",
+        help="Upgrades clang-tidy warnings to errors. Same format as '-checks'.",
+        default="",
+    )
+
 
     clang_tidy_args = []
     argv = sys.argv[1:]
@@ -374,6 +380,9 @@ def main():
         common_clang_tidy_args.append("-extra-arg-before=%s" % arg)
     for plugin in args.plugins:
         common_clang_tidy_args.append("-load=%s" % plugin)
+    if args.warnings_as_errors != "":
+        common_clang_tidy_args.append("-warnings-as-errors=" + args.warnings_as_errors)
+
 
     for name in lines_by_file:
         line_filter_json = json.dumps(

Copy link
Contributor

@HerrCai0907 HerrCai0907 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Please note this in release note

Copy link
Member

@PiotrZSL PiotrZSL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Release notes entry is missing.
Look into clang-tidy 20 release notes and just copy entry and adjust it.

@juru1234 juru1234 force-pushed the werror branch 3 times, most recently from 968350e to cd56aab Compare March 14, 2025 15:38
@carlosgalvezp
Copy link
Contributor

carlosgalvezp commented Mar 14, 2025

Nit: specify in the commit message title that this is about clang-tidy-diff.py. Otherwise it seems you are adding warnings as errors to clang-tidy itself.

This patch allows to treat warnings as erros using clang-tidy-diff.py.

Co-authored-by: Piotr Zegar <[email protected]>
@HerrCai0907 HerrCai0907 changed the title [clang-tidy] Add an option to treat warnings as errors [clang-tidy-diff] Add an option to treat warnings as errors Mar 17, 2025
@HerrCai0907 HerrCai0907 merged commit ccfabe8 into llvm:main Mar 17, 2025
7 checks passed
Copy link

@juru1234 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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants