On Jul 2, 2009, at 4:52 PM, Sam Weinig wrote:

While clearly a personal preference, I don't like the default prepare-changelog default text and would much rather we revert to the old one. I don't think the new text adds anything and will likely be ignored by most. Can we leave the --bug= option and revert to the old template?

I expressed concern that the new template is too noisy. However, the "OOPS" part of it can enable the tools to help you notice if you forgot to include a description. Maybe if we got rid of the all-caps other than "OOPS", and perhaps prepare-ChangeLog can prompt for a bug number instead of just inserting complaint text by default.

 - Maciej


-Sam


On Wed, Jul 1, 2009 at 10:44 PM, Eric Seidel <e...@webkit.org> wrote:
Background: Reviewers spend too much time correcting errors which
should be caught by tools.  This is frustrating both to contributers
and reviewers.  One such class of errors are missing or incorrect
information in ChangeLogs.  I'm trying to fix that.


As part of:
http://trac.webkit.org/changeset/45464

prepare-ChangeLog now takes an optional --bug= argument and is able to
fill in more than before:

% prepare-ChangeLog --bug=26383
 Running status to find changed, added, or removed files.
 Reviewing diff to determine which lines changed.
 Change author: Eric Seidel <e...@webkit.org>.
 Description from bug 26383:
   "prepare-ChangeLog should have a --bug= argument and use it for
url autofill".
 Editing the ../WebCore/ChangeLog file.

Results in:
2009-07-01  Eric Seidel  <e...@webkit.org>

       Reviewed by NOBODY (OOPS!).

       prepare-ChangeLog should have a --bug= argument and use it for
url autofill
       https://bugs.webkit.org/show_bug.cgi?id=26383

       DETAILED DESCRIPTION OF THE CHANGES GOES HERE. (OOPS!) SEE:
       http://webkit.org/coding/contributing.html FOR MORE INFORMATION

       Tests: fast/foo.html

       * foo.cpp: Added.



Running prepare-ChangeLog by default will however output more boiler- plate:

2009-07-01  Eric Seidel  <e...@webkit.org>

       Reviewed by NOBODY (OOPS!).

       SHORT DESCRIPTION/BUG TITLE GOES HERE (OOPS!)
       BUG URL GOES HERE (pass --bug= to autofill)

       DETAILED DESCRIPTION OF THE CHANGES GOES HERE. (OOPS!) SEE:
       http://webkit.org/coding/contributing.html FOR MORE INFORMATION

       LIST OF TESTS, OR EXPLANATION WHY TESTING IS IMPOSSIBLE GOES
HERE (OOPS!)

       * foo.cpp: Added.


However, hopefully the boilerplate is more helpful than before.


Unfortunately everyone will now see:
       DETAILED DESCRIPTION OF THE CHANGES GOES HERE. (OOPS!) SEE:
       http://webkit.org/coding/contributing.html FOR MORE INFORMATION

in their initial ChangeLogs.  This may be annoying to seasoned
contributers (and I'm open to removing it).  But hopefully it will
lead to better ChangeLogs overall.


Looking forward to your comments!

-eric
_______________________________________________
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

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

Reply via email to