Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 34839 - Build notes should reflect actual state
Summary: Build notes should reflect actual state
Status: RESOLVED DUPLICATE of bug 170545
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Releng (show other bugs)
Version: 2.1   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Platform-Releng-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-03-12 12:36 EST by Nikolay Entin CLA
Modified: 2007-03-14 16:29 EDT (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Nikolay Entin CLA 2003-03-12 12:36:36 EST
I'm sorry for posting the request here - didn't find more 
appropriate "product".
In Eclipse build notes there are links to results, which 
- lead to latest reports from 2002 (i.e. not actual and not interesting to 
anyone)
- do not show what had happen (which problems) in some important areas, e.g. 
PDE

I'm looking for bug reports, which are claimed to be fixed and I'd like to 
know if it's a part of nightly/integration build.
Quite often I can't find it in Build notes.

Would be nice if build notes will include somehow reference to a list of all 
closed bugs for the build.
Comment 1 Nick Edgar CLA 2003-03-25 15:46:24 EST
Although Platform UI has been particularly lax in this area, I agree that a 
complete list would be good.  Moving to Releng for commenting on the best 
process for doing this since it affects all teams.
Way back in LeapFrog days, team members used to just send one-line emails to 
the group giving the PR number and description
e.g. "Fixed 123456 - UI was broken"

For build notes, the build person just collected these into a list.




Comment 2 Dean Roberts CLA 2003-03-26 08:42:53 EST
My only comment would be that the teams should update their build notes as 
they are the only people in a position to know what bugs where really fixed in 
a particular build.

Perhaps we should have a discussion on the eclipse-dev mailing list about what 
people want to see in build notes.


Comment 3 Nick Edgar CLA 2003-03-26 09:47:28 EST
Probably should.  But not right now.  Let's do this early in 2.2.
Comment 4 Sonia Dimitrov CLA 2003-06-18 16:50:57 EDT
from eclipse-dev mailing list:

"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"
Comment 5 Jerome Lanneluc CLA 2003-06-19 05:34:42 EDT
In the JDT/Core team, each committer is responsible for updating the build 
notes and for adding an entry when he fixes or when he closes a bug. This works 
quite well, and since the build notes are part of the build contribution, they 
always reflect what is part of the build.
Comment 6 Sonia Dimitrov CLA 2007-03-14 16:29:55 EDT

*** This bug has been marked as a duplicate of bug 170545 ***