Bug 27098

Summary: Make prepare-ChangeLog less shouty
Product: WebKit Reporter: Maciej Stachowiak <mjs>
Component: Tools / TestsAssignee: Maciej Stachowiak <mjs>
Status: RESOLVED FIXED    
Severity: Normal    
Priority: P2    
Version: 528+ (Nightly build)   
Hardware: PC   
OS: OS X 10.5   
Attachments:
Description Flags
patch mrowe: review+

Description Maciej Stachowiak 2009-07-08 15:49:19 PDT
prepare-ChangeLog's new text is seen by some as overly verbose and SHOUTY.
Comment 1 Maciej Stachowiak 2009-07-08 15:54:34 PDT
Created attachment 32480 [details]
patch
Comment 2 Mark Rowe (bdash) 2009-07-08 15:57:19 PDT
Comment on attachment 32480 [details]
patch

r=me
Comment 3 Maciej Stachowiak 2009-07-08 15:58:04 PDT
I didn't solve every possible problem with prepare-ChangeLog, but I tried to make it a bit less shouty.

If you don't provide the --bug argument, it includes text like this:

---------
2009-07-08  Maciej Stachowiak  <mjs@apple.com>

       Reviewed by NOBODY (OOPS!).

       Need a short description and bug URL (OOPS!)

       * Scripts/prepare-ChangeLog:
---------

If you do use --bug, it provides text like this:

---------
2009-07-08  Maciej Stachowiak  <mjs@apple.com>

       Reviewed by NOBODY (OOPS!).

       Make prepare-ChangeLog less shouty
       https://bugs.webkit.org/show_bug.cgi?id=27098

       * Scripts/prepare-ChangeLog:
---------


It also says this on the console (not in the ChangeLog):

-- Please remember to include a detailed description in your ChangeLog entry. --
-- See <http://webkit.org/coding/contributing.html> for more info --
Comment 4 Eric Seidel (no email) 2009-07-08 16:00:10 PDT
Comment on attachment 32480 [details]
patch

+    print CHANGE_LOG normalizeLineEndings("        $bugDescription\n", $endl) if $bugDescription;

does not need to be conditional anymore.  You can remove the "if ..." part.

+            print CHANGE_LOG normalizeLineEndings("        No new tests. (OOPS!)\n\n", $endl);

Seems like that line will often be left in by casual contributers.  Mabe just change it back to the WARNING: line before my change?  Really, it's up to you.
Comment 5 Maciej Stachowiak 2009-07-09 01:13:52 PDT
At least when I was testing, the conditional was needed, otherwise it inserted extra blank lines.

The "OOPS!" will prevent the "lack of tests" line from being committed as-is. If we also make post-diff complain about it, we should be golden.
Comment 6 Maciej Stachowiak 2009-07-09 01:14:37 PDT
Also: I committed this.