Changeset 282391 in webkit

Timestamp:

Sep 14, 2021, 8:56:51 AM (5 years ago)

Author:

commit-queue@webkit.org

Message:

Provide a way to update the commit message with an updated list of changed files/functions
​https://bugs.webkit.org/show_bug.cgi?id=230195

Patch by Hoa Dinh <​dvh@apple.com> on 2021-09-14
Reviewed by Jonathan Bedard.

Add a new parameter --only-files to request generation of only the part of the changed files/functions.

• Scripts/prepare-ChangeLog:

(main):
(generateNewChangeLogs):

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/prepare-ChangeLog (modified) (8 diffs)

trunk/Tools/ChangeLog

@@ +1 @@
+2021-09-14  Hoa Dinh  <dvh@apple.com>
+
+        Provide a way to update the commit message with an updated list of changed files/functions
+        https://bugs.webkit.org/show_bug.cgi?id=230195
+
+        Reviewed by Jonathan Bedard.
+
+        Add a new parameter --only-files to request generation of only the part of the changed files/functions.
+
+        * Scripts/prepare-ChangeLog:
+        (main):
+        (generateNewChangeLogs):
+
 2021-09-13  Wenson Hsieh  <wenson_hsieh@apple.com>
 

trunk/Tools/Scripts/prepare-ChangeLog

@@ -85 +85 @@
 sub generateFileList(\%$$$\%);
 sub generateFunctionLists($$$$$);
-sub generateNewChangeLogs($$$$$$$$$$$$$$);
+sub generateNewChangeLogs($$$$$$$$$$$$$$$);
 sub getLatestChangeLogs($);
 sub get_function_line_ranges($$);
@@ -146 +146 @@
     my $spewDiff = $ENV{"PREPARE_CHANGELOG_DIFF"};
     my $updateChangeLogs = 1;
+    my $onlyFiles = 0;
     my $parseOptionsResult =
         GetOptions("diff|d!" => \$spewDiff,
@@ -161 +162 @@
                    "open|o!" => \$openChangeLogs,
                    "write!" => \$writeChangeLogs,
-                   "update!" => \$updateChangeLogs);
+                   "update!" => \$updateChangeLogs,
+                   "only-files" => \$onlyFiles);
     if (!$parseOptionsResult || $showHelp) {
         print STDERR basename($0) . " [-b|--bug=<bugid>] [-d|--diff] [-h|--help] [-o|--open] [-g|--git-commit=<committish>] [--git-reviewer=<name>] [svndir1 [svndir2 ...]]\n";
@@ -179 +181 @@
         print STDERR "  --delimiters    When writing to stdout, label and print a \"~\" after each entry\n";
         print STDERR "  --email=        Specify the email address to be used in the patch\n";
+        print STDERR "  --only-files    Exclude the standard changelog header and only include references to files.\n";
         return 1;
     }
@@ -238 +241 @@
     }
 
-    generateNewChangeLogs($prefixes, $filesInChangeLog, $addedRegressionTests, $requiresTests, $functionLists, $bugURL, $bugDescription, $bugRadarURL, $name, $emailAddress, $gitReviewer, $gitCommit, $writeChangeLogs, $delimiters);
+    generateNewChangeLogs($prefixes, $filesInChangeLog, $addedRegressionTests, $requiresTests, $functionLists, $bugURL, $bugDescription, $bugRadarURL, $name, $emailAddress, $gitReviewer, $gitCommit, $writeChangeLogs, $delimiters, $onlyFiles);
 
     if ($writeChangeLogs) {
@@ -632 +635 @@
 }
 
-sub generateNewChangeLogs($$$$$$$$$$$$$$)
-{
-    my ($prefixes, $filesInChangeLog, $addedRegressionTests, $requiresTests, $functionLists, $bugURL, $bugDescription, $bugRadarURL, $name, $emailAddress, $gitReviewer, $gitCommit, $writeChangeLogs, $delimiters) = @_;
+sub generateNewChangeLogs($$$$$$$$$$$$$$$)
+{
+    my ($prefixes, $filesInChangeLog, $addedRegressionTests, $requiresTests, $functionLists, $bugURL, $bugDescription, $bugRadarURL, $name, $emailAddress, $gitReviewer, $gitCommit, $writeChangeLogs, $delimiters, $onlyFiles) = @_;
 
     my $hasWebCoreChange = 0;
@@ -668 +671 @@
         }
 
-        my $date = changeLogDate(ChangeLogTimeZone);
-        print CHANGE_LOG normalizeLineEndings("$date  $name  <$emailAddress>\n\n", $endl);
+        if (!$onlyFiles) {
+            my $date = changeLogDate(ChangeLogTimeZone);
+            print CHANGE_LOG normalizeLineEndings("$date  $name  <$emailAddress>\n\n", $endl);
+        }
 
         my ($reviewer, $description) = reviewerAndDescriptionForGitCommit($gitCommit, $gitReviewer) if $gitCommit;
@@ -681 +686 @@
         $bugURL = "Need the bug URL (OOPS!)." unless $bugURL;
 
-        print CHANGE_LOG normalizeLineEndings("        $bugDescription\n", $endl) if $bugDescription;
-        print CHANGE_LOG normalizeLineEndings("        $bugURL\n", $endl) if $bugURL;
-        print CHANGE_LOG normalizeLineEndings("        $bugRadarURL\n", $endl) if $bugRadarURL;
-        print CHANGE_LOG normalizeLineEndings("\n", $endl);
-
-        print CHANGE_LOG normalizeLineEndings("        Reviewed by $reviewer.\n\n", $endl);
-        print CHANGE_LOG normalizeLineEndings($description . "\n", $endl) if $description;
+        if (!$onlyFiles) {
+            print CHANGE_LOG normalizeLineEndings("        $bugDescription\n", $endl) if $bugDescription;
+            print CHANGE_LOG normalizeLineEndings("        $bugURL\n", $endl) if $bugURL;
+            print CHANGE_LOG normalizeLineEndings("        $bugRadarURL\n", $endl) if $bugRadarURL;
+            print CHANGE_LOG normalizeLineEndings("\n", $endl);
+
+            print CHANGE_LOG normalizeLineEndings("        Reviewed by $reviewer.\n\n", $endl);
+            print CHANGE_LOG normalizeLineEndings($description . "\n", $endl) if $description;
+        }
 
         my $shouldMentionTests = @$requiresTests;