Let ChangeLog get auto-generated in push-to-trunk script.

tools/push-to-trunk/push_to_trunk.py

 #!/usr/bin/env python
 # Copyright 2013 the V8 project authors. All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #     * Redistributions of source code must retain the above copyright
 #       notice, this list of conditions and the following disclaimer.
 #     * Redistributions in binary form must reproduce the above
 #       copyright notice, this list of conditions and the following
@@ skipping 94 matching lines @@
     self.Persist("date", date)
     output = "%s: Version %s.%s.%s\n\n" % (date,
                                            self._state["major"],
                                            self._state["minor"],
                                            self._state["build"])
     TextToFile(output, self.Config(CHANGELOG_ENTRY_FILE))
 
     args = "log %s..HEAD --format=%%H" % self._state["last_push"]
     commits = self.Git(args).strip()
 
-    def GetCommitMessages():
-      for commit in commits.splitlines():
-        yield [
-          self.Git("log -1 %s --format=\"%%w(80,8,8)%%s\"" % commit),
-          self.Git("log -1 %s --format=\"%%B\"" % commit),
-          self.Git("log -1 %s --format=\"%%w(80,8,8)(%%an)\"" % commit),
-        ]
+    # Cache raw commit messages.
+    commit_messages = [
+      [
+        self.Git("log -1 %s --format=\"%%w(80,8,8)%%s\"" % commit),
+        self.Git("log -1 %s --format=\"%%B\"" % commit),
+        self.Git("log -1 %s --format=\"%%w(80,8,8)(%%an)\"" % commit),
+      ] for commit in commits.splitlines()
+    ]
 
-    body = MakeChangeLogBody(GetCommitMessages)
+    # Auto-format commit messages.
+    body = MakeChangeLogBody(commit_messages, auto_format=True)
     AppendToFile(body, self.Config(CHANGELOG_ENTRY_FILE))
 
-    msg = "        Performance and stability improvements on all platforms.\n"
+    msg = ("        Performance and stability improvements on all platforms."
+           "\n#\n# The change log above is auto-generated. Please review if "
+           "all relevant\n# commit messages from the list below are included."
+           "\n# All lines starting with # will be stripped.\n#\n")
     AppendToFile(msg, self.Config(CHANGELOG_ENTRY_FILE))
 
+    # Include unformatted commit messages as a reference in a comment.
+    comment_body = MakeComment(MakeChangeLogBody(commit_messages))
+    AppendToFile(comment_body, self.Config(CHANGELOG_ENTRY_FILE))
+
 
 class EditChangeLog(Step):
   def __init__(self):
     Step.__init__(self, "Edit ChangeLog entry.")
 
   def RunStep(self):
     print ("Please press <Return> to have your EDITOR open the ChangeLog "
            "entry, then edit its contents to your liking. When you're done, "
            "save the file and exit your EDITOR. ")
     self.ReadLine(default="")
 
     # TODO(machenbach): Don't use EDITOR in forced mode as soon as script is
     # well tested.
     self.Editor(self.Config(CHANGELOG_ENTRY_FILE))
     handle, new_changelog = tempfile.mkstemp()
     os.close(handle)
 
-    # (1) Eliminate tabs, (2) fix too little and (3) too much indentation, and
-    # (4) eliminate trailing whitespace.
+    # (1) Strip comments, (2) eliminate tabs, (3) fix too little and (4) too

[Jakob Kummerow, 2013/11/21 09:17:05]

This section is a candidate for Pythonification. Instead of the MSub() call
sequence, every line should go through .strip() (if that's even necessary to do
explicitly) and the new Fill80(). Then these comments will be unnecessary.
(Feel free to do that in a subsequent CL.)

+    # much indentation, and (5) eliminate trailing whitespace.
     changelog_entry = FileToText(self.Config(CHANGELOG_ENTRY_FILE)).rstrip()
+    changelog_entry = StripComments(changelog_entry)
     changelog_entry = MSub(r"\t", r"        ", changelog_entry)
     changelog_entry = MSub(r"^ {1,7}([^ ])", r"        \1", changelog_entry)
     changelog_entry = MSub(r"^ {9,80}([^ ])", r"        \1", changelog_entry)
     changelog_entry = MSub(r" +$", r"", changelog_entry)
 
     if changelog_entry == "":
       self.Die("Empty ChangeLog entry.")
 
     with open(new_changelog, "w") as f:
       f.write(changelog_entry)
@@ skipping 402 matching lines @@
 def Main():
   parser = BuildOptions()
   (options, args) = parser.parse_args()
   if not ProcessOptions(options):
     parser.print_help()
     return 1
   RunPushToTrunk(CONFIG, options)
 
 if __name__ == "__main__":
   sys.exit(Main())