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  <m...@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  <m...@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 --

I think this should address the significant concerns. If there's a desire to reorder the lines or add angle brackets or whatever, people can propose follow-up changes.

Also, please review my patch!

Regards,
Maciej


On Jul 7, 2009, at 10:44 AM, Eric Seidel wrote:

Oh, I did really like the idea of a prepare-ChangeLog "wizard" which
someone suggested.  Where it might ask you some of the relevant
questions instead of filling in boilerplate.

I continue to find it frustrating that I have to r- patches with bad
ChangeLogs. :)  I don't think that's so much contributer failure as it
is tools failure.  The tools should make it easy to do the "right
thing" and hard to post patches which are just gonna get r-'d.

-eric

On Tue, Jul 7, 2009 at 10:42 AM, Eric Seidel<e...@webkit.org> wrote:
I had intended to summarize this long thread which I started.  But
I've since realized that we're mostly bikeshedding here, so there
isn't much actionable takeaway. :(  Thank you to all of you for your
thoughtful responses!

I'm not at all attached to the current YELLING CHANGELOG TEMPLATE. :)
But I don't feel like I can draw action from this thread.

I'm happy to review further changes to prepare-ChangeLog (as I'm sure
others are).  So if anyone feels strongly that it's currently broken,
please feel free to post a patch. :)

-eric

On Fri, Jul 3, 2009 at 4:51 PM, David Kilzer<ddkil...@webkit.org> wrote:

On Friday, July 3, 2009 2:19:51 PM, Maciej Stachowiak wrote:

What I do (and I think many of us do) is use a script that
automatically fills in the commit message from the ChangeLog.

The script is WebKitTools/Scripts/commit-log-editor. Setting one of these environment variables (depending on whether you're using svn or git) works great (replace "$WEBKIT_SRC_DIR" with the path to your webkit source, or just set them to "commit-log-editor" if you've added WebKitTools/Scripts to your PATH):

GIT_EDITOR=$WEBKIT_SRC_DIR/WebKitTools/Scripts/commit-log-editor
SVN_EDITOR=$WEBKIT_SRC_DIR/WebKitTools/Scripts/commit-log-editor

You'll also want to set the EDITOR environment variable unless you use vi to edit your svn/git commit logs. :)

Dave

_______________________________________________
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev



_______________________________________________
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev

Reply via email to