[webkit-dev] Changes to prepare-ChangeLog

[David Kilzer]

On Friday, July 3, 2009 3:20:58 AM, Alexey Proskuryakov wrote:

> 02.07.2009, в 18:05, Adam Roben написал(а):
> 
> > Here's an example entry that follows the format that I (and
> > I think Dave) like:
> >
> > +2009-04-20  Adam Roben  <aroben at apple.com>
> > +
> > +        Change MemoryStream::createInstance to return a COMPtr
> > +
> > +        Part of Bug 25294: All WebKit/win classes should return COMPtrs from
> > +        their static constructor members
> > +        <https://bugs.webkit.org/show_bug.cgi?id=25294>
> 
> FWIW, I rarely need to know the bug number alone - I need its
> URL to click or to copy/paste. On the other hand, the
> suggested format makes it so that one needs to skip over "Part
> of Bug 25294: " just to read the bug description, which is not
> an improvement.

This probably isn't a typical example since it's a "Part N of M" bug fix, but the important part is that the change is summarized on the first line (after the date and patch author) to give a quick overview of the patch.

> >>- I like putting angle brackets "<>" around the URL to set
> >>it off visually from other text.
> 
> Typing those brackets is more work. It's also more difficult
> to copy/paste the URL (you could just copy the whole line and
> paste it into Safari address bar when there were no garbage
> symbols around the URL)


Actually, Safari will strip the "<>" characters for you if you paste them into the address bar!  I didn't know this until a couple of months ago, either.

Dave