[webkit-dev] ChangeLogs

[Adam Barth]

On Wed, Mar 21, 2012 at 3:45 PM, Timothy Hatcher <timothy at apple.com> wrote:
> On Mar 21, 2012, at 2:46 PM, Adam Barth wrote:
>> On Wed, Mar 21, 2012 at 2:29 PM, Timothy Hatcher <timothy at apple.com> wrote:
>>> Lately I have observed more and more and more changes going into WebKit that
>>> lack any details about why a particular change was made. It is intended that
>>> the ChangeLog (and commit message) contain some details about your change,
>>> not just the bug title and URL.
>>
>> Since I was the reviewer for <http://trac.webkit.org/changeset/111577>
>> (although if you look in the bug thread, you'll see that I was just
>> forwarding fishd's R+ after some trivial cleanups), I'm curious what
>> additional information you think should have been included in that
>> ChangeLog.
>>
>> There really isn't much to say about that change.  Tommy was just
>> adding thin API wrappers around WebCore objects as part of the
>> implementation of the MediaStream API.  The main point of discussion
>> in the bug thread was whether to use the name ICE or Ice.
>
> "Adding thin API wrappers around WebCore objects as part of the implementation of the MediaStream API." would be a good start. I shouldn't have to troll through a bug with 21 comments to figure out a change. Also the WebCore changes are just case changes, but you wouldn't know that by just perusing the ChangeLog/commit message.

Yeah, I definitely find ChangeLog messages useful for filtering which
changes to dig into in more detail (e.g., when hunting for a
regression).  Thanks!

Adam