Format for JDK 6/7 changeset comments?

iris.clark at sun.com iris.clark at sun.com
Fri Nov 9 18:07:25 UTC 2007


Hi, David.

> Are you suggesting that once the cause of a bug is determined then the 
> synopsis should be changed to reflect that? I've updated a few "bad" 
> synopses in my time too, but not generally to the extent of changing 
> them from being failure oriented to being cause oriented.

As the initial evaluator of several java subcategories I regularly
update a bug's synopsis.  The key condition is that a user
encountering the problem should be able to find the bug based upon the
most obvious symptom; for an RFE, the synopsis should describe the
desired end result.  A series of bugs that have the same cause will
probably be marked as duplicates or "see also" bugs, so it is not
necessary to encode this information in the synopsis.

Details describing the cause of the bug, approach for the solution,
and other technical details belong in the bug's evaluation.  I don't
believe that these technical details belong in the changeset comments
because we expect them to often be extensive.  I think the bug's
evaluation is a more suitable location.

iris










More information about the discuss mailing list