Bug 58120 – prepare-ChangeLog does not follow the ChangeLog style properly

• Component: Tools / Tests
• Status: UNCONFIRMED

[Kristian Amlie]

One example can be found in the comment to https://bugs.webkit.org/show_bug.cgi?id=57015#c8, where prepare-ChangeLog consistently puts the description above the bug number, when in fact, it should be below, like in the following changeset http://trac.webkit.org/changeset/83184.

[Kristian Amlie]

Created attachment 88778 [details]
Fixed-ChangeLog-style-issue-in-prepare-ChangeLog

[Alexey Proskuryakov]

That used to be my preference too, but now it seems that almost everyone puts description first. Shouldn't we just agree on the common practice?

[Eric Seidel (no email)]

Do we have this documented somewhere?

I don't really care where it goes.  Ironically your ChangeLog follows the old style?

[Kristian Amlie]

(In reply to comment #3)
> Do we have this documented somewhere?

I don't think so. The documentation at http://www.webkit.org/coding/contributing.html says that prepare-ChangeLog is what you should use, so I guess the implementation is the documentation is this case. :-P

> I don't really care where it goes.  Ironically your ChangeLog follows the old style?

Uhm, does it?

The bug summary and bug number come first, and then the full description, which is what prepare-ChangeLog is patched to do as well...

[Kristian Amlie]

(In reply to comment #4)
> (In reply to comment #3)
> > Do we have this documented somewhere?
> 
> I don't think so. The documentation at http://www.webkit.org/coding/contributing.html says that prepare-ChangeLog is what you should use, so I guess the implementation is the documentation is this case. :-P

It does seem to be the common practice though.

[Adam Roben (:aroben)]

Comment on attachment 88778 [details]
Fixed-ChangeLog-style-issue-in-prepare-ChangeLog

This bug needs a better description, and this patch should have a better ChangeLog. This patch only affects the behavior of the --git-commit flag, which isn't clear at all from the bug or ChangeLog.