add_new_check.py: Update of the template to add an autofix section
authorSylvestre Ledru <sledru@mozilla.com>
Mon, 13 Apr 2020 20:22:19 +0000 (22:22 +0200)
committerSylvestre Ledru <sledru@mozilla.com>
Sun, 10 May 2020 09:25:19 +0000 (11:25 +0200)
Summary: As discussed here: https://reviews.llvm.org/D77983

Reviewers: alexfh

Subscribers: cfe-commits

Tags: #clang

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

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

index 4477444..fa8b4da 100755 (executable)
@@ -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)})