Format for JDK 6/7 changeset comments?
aph at redhat.com
Tue Nov 6 09:23:04 PST 2007
Kelly O'Hair writes:
> I agree.
> The more you put in the changeset comment, the higher the odds that
> there will be mistakes in those comments, mistakes that can NEVER
> be corrected.
> I favor keeping it short and sweet, and use the bug database for
> all other information. A place that can be corrected and added to
> over time.
> Of course the bug database needs to refer to the changeset, which
> IS the true source of the change. Any webrevs and diffs in the bug
> database should probably be removed once a changeset is public, or
> perhaps multiple changesets depending on how many it takes to
> really fix a bug. You don't want incorrect diffs or webrevs
> floating around when the true change is in the changeset.
Hmm. Does this mean that the checkin comments are not written until
after the reviewer has done their work? That seems wrong. In gcc we
write the change log entry when we submit a change.
Also, IMO the supplemental information about the bug should be
automatically copied into a mailing list as part of the same thread to
which the change itself was copied. That way, you only need mailing
list searching software to find everything. It would be better not to
depend on the bug database in order to find out why something has
changed, or indeed what has changed.
Red Hat UK Ltd, Amberley Place, 107-111 Peascod Street, Windsor, Berkshire, SL4 1TE, UK
Registered in England and Wales No. 3798903
More information about the discuss