Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[eclipse-dev] Consistent build notes

Someone noted in an unrelated bug report that our build notes are 
formatted quite inconsistently. It was noted, and I have to agree, that 
this makes them hard to read.

There are a few different formats used for the header, although the most 
common seems to be:
Eclipse Platform Build Notes 
<component>

Then the build id/date is different for most build notes, followed by a 
list of bug fixes or a link to a bugzilla report.

I wonder if releng can accept build notes for four common categories and 
compile them into a report for each component using a standard template. 
This would also allow to compile and categorize the build notes in 
different ways in the future. For example you could provide just those 
build notes relevant to the current build instead of cumulative.
The common denominator for the categories seems to be:

What's new in this drop
Other highlights
Known deficiencies
Problem reports fixed

Also, jdt-ui has three different build notes apparently for different 
release levels all linked off individual builds. Let's say there is a 
usability problem with the build notes. Who wants to fix it?

Knut


Back to the top