On Jul 9, 2009, at 4:33 AM, David Kilzer wrote:
2009-07-08 Maciej Stachowiak <[email protected]>
- <http://webkit.org/b/27098> Make prepare-ChangeLog less shouty
Reviewed by Mark Rowe.
Hypothetical long description goes here. Yeah. Very long and
detailed it is.
* Scripts/prepare-ChangeLog:
Random nits (since you asked):
* Please do not put a "-" in front of the bug line. What does that
buy you besides (sometimes) a bullet in trac.webkit.org?
Mark Rowe said the same thing. Agreed.
* What does the format look like for bugs with multiple URL links,
e.g., to <rdar://problem/NNNNNNN> or to <http://crbug.com/NNNNN>?
(The title should not have to be repeated--you should be fixing the
same issue for all of them.)
I could think of two reasonable options?
<http://webkit.org/b/27098><rdar://problem/12345> Make prepare-
ChangeLog less shouty
Reviewed by Mark Rowe.
<http://webkit.org/b/27098> Make prepare-ChangeLog less shouty
<rdar://problem/7123456>
Reviewed by Mark Rowe.
Preferences?
* Is the "Reviewed by" line going to have a blank line above it? (I
think it should, but I could be persuaded otherwise.)
I don't think it should, if it's one of two special lines at the top.
Otherwise the whole ChangeLog entry looks double-spaced and gets
harder to read.
And from The-World-is-Not-Enough Department:
* The commit-log-editor should be smart about condensing duplicate
content after the date-name-email lines for each ChangeLog entry,
and it should move those lines to the top of the commit message.
(This also makes git users happy since the first line would be the
bug URL and description, making "git log --oneline" more useful.)
I'm not sure I understand this suggestion.
- Maciej
Dave
----- Original Message ----
From: Maciej Stachowiak <[email protected]>
To: Maciej Stachowiak <[email protected]>
Cc: WebKit Development <[email protected]>
Sent: Thursday, July 9, 2009 1:47:16 AM
Subject: Re: [webkit-dev] Changes to prepare-ChangeLog
I discussed with Mark Rowe on IRC a bit and it seems like it would
be nice if
the bug URL could be short enough to just go on one line with the
summary. Which
turns out to be totally doable. Thus the latest format proposal
(the /b/ URL is
a redirect):
2009-07-08 Maciej Stachowiak
- <http://webkit.org/b/27098> Make prepare-ChangeLog less
shouty
Reviewed by Mark Rowe.
Hypothetical long description goes here. Yeah. Very long and
detailed it is.
* Scripts/prepare-ChangeLog:
On Jul 9, 2009, at 1:32 AM, Maciej Stachowiak wrote:
Now that my attention has been called to it, it's starting to bug
me that
everyone formats their ChangeLog entries slightly differently. How
about this as
the canonical format (with prepare-ChangeLog encouraging it)?
2009-07-08 Maciej Stachowiak
Make prepare-ChangeLog less shouty
https://bugs.webkit.org/show_bug.cgi?id=27098
Reviewed by Mark Rowe.
* Scripts/prepare-ChangeLog:
So specifically:
- Reviewed by line would go below, not above, to make git users
happy (well,
happi*er*)
- Bug URL remains below one-line description, for git joy and
scannability
- No angle brackets around URL, so that you can cut/paste or drag
it from a
URL field without extra work
- No line between URL and summary
Is that a format everyone can live with for ChangeLogs and commit
messages? If
so, I'll post a patch to update prepare-ChangeLog accordingly.
Regards,
Maciej
_______________________________________________
webkit-dev mailing list
[email protected]
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev
_______________________________________________
webkit-dev mailing list
[email protected]
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev
