[clang-tools-extra] f97f92e - add_new_check.py: Update of the template to add an autofix section

Sylvestre Ledru via cfe-commits cfe-commits at lists.llvm.org
Sun May 10 02:26:04 PDT 2020


Author: Sylvestre Ledru
Date: 2020-05-10T11:25:19+02:00
New Revision: f97f92e5b0fd14240c2ec27c44e1b3cfddfdf668

URL: https://github.com/llvm/llvm-project/commit/f97f92e5b0fd14240c2ec27c44e1b3cfddfdf668
DIFF: https://github.com/llvm/llvm-project/commit/f97f92e5b0fd14240c2ec27c44e1b3cfddfdf668.diff

LOG: add_new_check.py: Update of the template to add an autofix section

Summary: As discussed here: https://reviews.llvm.org/D77983

Reviewers: alexfh

Subscribers: cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D78052

Added: 
    

Modified: 
    clang-tools-extra/clang-tidy/add_new_check.py

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/clang-tidy/add_new_check.py b/clang-tools-extra/clang-tidy/add_new_check.py
index 4477444cc127..fa8b4da4d624 100755
--- a/clang-tools-extra/clang-tidy/add_new_check.py
+++ b/clang-tools-extra/clang-tidy/add_new_check.py
@@ -391,6 +391,30 @@ def write_docs(module_path, module, check_name):
 %(underline)s
 
 FIXME: Describe what patterns does the check detect and why. Give examples.
+
+FIXME: Remove of the following section:
+
+Automatic Fixes
+^^^^^^^^^^^^^^^
+
+The check doesn't provide an automatic fix.
+
+or
+
+Automatic Fixes
+^^^^^^^^^^^^^^^
+
+The check provides suggested fixes. See the documentation above for the details.
+
+or
+
+Automatic Fixes
+^^^^^^^^^^^^^^^
+
+The check provides suggested fixes in the following cases:
+1.
+2.
+3.
 """ % {'check_name_dashes': check_name_dashes,
        'underline': '=' * len(check_name_dashes)})
 


        


More information about the cfe-commits mailing list