Changeset 90229 in webkit

Timestamp:

Jul 1, 2011, 8:21:02 AM (15 years ago)

Author:

Adam Roben

Message:

commit-log-editor reorders ChangeLog entries in unexpected ways
​https://bugs.webkit.org/show_bug.cgi?id=63804

Reviewed by Darin Adler.

commit-log-editor was changed in r46899 to move the bug title and URL to the top of the
commit message in order to make git-based tools, which expect the first line of the commit
message to be a summary of the change, to work better. But this reordering of the ChangeLog
entry was unpredictable and unexpected.

I changed prepare-ChangeLog to put the bug title and URL at the top of the ChangeLog entry
so that commit-log-editor doesn't have to move them. Then I changed commit-log-editor not to
try to move them.

• Scripts/commit-log-editor: Partially reverted r46899. We no longer save the "Reviewed by"

line and try to move it down below the bug title and URL. The order of the text in the
ChangeLog is now preserved, except that we insert a "Patch by" line just above the "Reviewed
by" line in cases where the committer and author are not the same person.

• Scripts/prepare-ChangeLog: Moved the "Reviewed by" line down below the bug title and URL.

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/commit-log-editor (modified) (5 diffs)
• Scripts/prepare-ChangeLog (modified) (2 diffs)

trunk/Tools/ChangeLog

@@ +1 @@
+2011-07-01  Adam Roben  <aroben@apple.com>
+
+        commit-log-editor reorders ChangeLog entries in unexpected ways
+        https://bugs.webkit.org/show_bug.cgi?id=63804
+
+        Reviewed by Darin Adler.
+
+        commit-log-editor was changed in r46899 to move the bug title and URL to the top of the
+        commit message in order to make git-based tools, which expect the first line of the commit
+        message to be a summary of the change, to work better. But this reordering of the ChangeLog
+        entry was unpredictable and unexpected.
+
+        I changed prepare-ChangeLog to put the bug title and URL at the top of the ChangeLog entry
+        so that commit-log-editor doesn't have to move them. Then I changed commit-log-editor not to
+        try to move them.
+
+        * Scripts/commit-log-editor: Partially reverted r46899. We no longer save the "Reviewed by"
+        line and try to move it down below the bug title and URL. The order of the text in the
+        ChangeLog is now preserved, except that we insert a "Patch by" line just above the "Reviewed
+        by" line in cases where the committer and author are not the same person.
+
+        * Scripts/prepare-ChangeLog: Moved the "Reviewed by" line down below the bug title and URL.
+
 2011-07-01  Mihnea Ovidenie  <mihnea@adobe.com>
 

trunk/Tools/Scripts/commit-log-editor

@@ -153 +153 @@
     my $contents = "";
     my $blankLines = "";
-    my $reviewedByLine = "";
     my $lineCount = 0;
     my $date = "";
@@ -164 +163 @@
         }
         if (/\S/) {
-            my $previousLineWasBlank = 1 unless $blankLines eq "";
+            $contents .= $blankLines if $contents;
+            $blankLines = "";
+
             my $line = $_;
-            my $currentLineBlankLines = $blankLines;
-            $blankLines = "";
 
             # Remove indentation spaces
             $line =~ s/^ {8}//;
-
-            # Save the reviewed / rubber stamped by line.
-            if ($line =~ m/^Reviewed by .*/ || $line =~ m/^Rubber[ \-]?stamped by .*/) {
-                $reviewedByLine = $line;
-                next;
-            }
 
             # Grab the author and the date line
@@ -187 +180 @@
             }
 
-            $contents .= $currentLineBlankLines if $contents;
-
-            # Attempt to insert the "patch by" line, after the first blank line.
-            if ($previousLineWasBlank && $hasAuthorInfoToWrite && $lineCount > 0) {
+            if ($line =~ m/^Reviewed by .*/ || $line =~ m/^Rubber[ \-]?stamped by .*/) {
+                # Insert the "Patch by" line just above the "Reviewed by" line, if needed.
                 my $committerEmail = changeLogEmailAddress();
                 my $authorAndCommitterAreSamePerson = $email eq $committerEmail;
@@ -199 +190 @@
             }
 
-            # Attempt to insert the "reviewed by" line, after the first blank line.
-            if ($previousLineWasBlank && $reviewedByLine && $lineCount > 0) {
-                $contents .= $reviewedByLine . "\n";
-                $reviewedByLine = "";
-            }
 
             $lineCount++;
@@ -210 +196 @@
             $blankLines .= $_;
         }
-    }
-    if ($reviewedByLine) {
-        $contents .= "\n".$reviewedByLine;
     }
     close CHANGELOG;

trunk/Tools/Scripts/prepare-ChangeLog

@@ -394 +394 @@
     $reviewer = "NOBODY (OO" . "PS!)" if !$reviewer;
 
-    print CHANGE_LOG normalizeLineEndings("        Reviewed by $reviewer.\n\n", $endl);
     print CHANGE_LOG normalizeLineEndings($description . "\n", $endl) if $description;
 
@@ -401 +400 @@
     print CHANGE_LOG normalizeLineEndings("        $bugURL\n", $endl) if $bugURL;
     print CHANGE_LOG normalizeLineEndings("\n", $endl);
+
+    print CHANGE_LOG normalizeLineEndings("        Reviewed by $reviewer.\n\n", $endl);
 
     if ($prefix =~ m/WebCore/ || `pwd` =~ m/WebCore/) {