clang-tidy: add_new_check.py stubs out release notes

[LegalizeAdulthood]

Summary

Update add_new_check.py to stub out information in the release notes for the new check.

[LegalizeAdulthood]

clang-tidy/add_new_check.py

283

Alex changed the formatting, so this will need to be rebased.

[alexfh]

I like the idea, but we could make this a bit more reliable, see the inline comment.

clang-tidy/add_new_check.py

280

Maybe instead add a special placeholder to the .rst file (something like <describe new clang-tidy checks here>) and insert new text right _before_ it? This will solve two problems: dependency on the formatting of the text and chronological order of the notes.

[hintonda]

With this change, won't you need to update 2 different repos: clang and extra? Is it possible to update both with a single Phabricator patch?

[Eugene.Zelenko]

Please use single ` around check name and also add link. See D18582 as example.

[alexfh]

In D18509#388071, @hintonda wrote:

With this change, won't you need to update 2 different repos: clang and extra? Is it possible to update both with a single Phabricator patch?

Clang-tidy release notes are now in the clang-tools-extra repository.

[LegalizeAdulthood]

In D18509#388071, @hintonda wrote:

With this change, won't you need to update 2 different repos: clang and extra? Is it possible to update both with a single Phabricator patch?

This is updating the release notes in the extra repository. (The release notes are new to this repository; you may not have noticed them being added.)

[etienneb]

I like this :)

[LegalizeAdulthood]

Review takes too long to make forward progress; abandoning.

clang-tidy/add_new_check.py

 
 %(check_name_dashes)s
 %(underline)s
 
 FIXME: Describe what patterns does the check detect and why. Give examples.
 """ % {"check_name_dashes" : check_name_dashes,
        "underline" : "=" * len(check_name_dashes)})
 
+
+# Adds the new check to the release notes for clang-tidy
+def adapt_release_notes(module_path, module, check_name):
+  check_name_dashes = module + '-' + check_name
+  filename = os.path.normpath(
+    os.path.join(module_path, '../../docs/ReleaseNotes.rst'))
+  print('Updating %s...' % filename)
+  with open(filename, 'r') as release_notes:
+    lines = release_notes.readlines()
+  with open(filename, 'w') as release_notes:
+    clang_tidy_found = False
+    clang_tidy_heading_found = False
+    bullet_found = False
+
+    for line in lines:
+      if not clang_tidy_found:
+        if line.startswith("Improvements to ``clang-tidy``"):
+          clang_tidy_found = True
+      elif not clang_tidy_heading_found:
+        if line.startswith('^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^'):
+          clang_tidy_heading_found = True
+      elif not bullet_found:
+        if line.startswith('- '):
+          bullet_found = True
+          release_notes.write('- New ``' + check_name_dashes + '`` check\n')
+          release_notes.write('\n')
+          release_notes.write('  FIXME: summarize the check\n')
+          release_notes.write('\n')
+      release_notes.write(line)
+  pass
+
+
 def main():
   if len(sys.argv) == 2 and sys.argv[1] == '--update-docs':
     update_checks_list(os.path.dirname(sys.argv[0]))
     return
 
   if len(sys.argv) != 3:
     print """\
 Usage: add_new_check.py <module> <check>, e.g.
documentation files."""
 
   if not adapt_cmake(module_path, check_name_camel):
     return
   write_header(module_path, module, check_name, check_name_camel)
   write_implementation(module_path, module, check_name_camel)
   adapt_module(module_path, module, check_name, check_name_camel)
   write_test(module_path, module, check_name)
   write_docs(module_path, module, check_name)
+  adapt_release_notes(module_path, module, check_name)
   update_checks_list(clang_tidy_path)
   print('Done. Now it\'s your turn!')
 
 if __name__ == '__main__':
   main()