I agree that we need to ship some form of change/feature file in the
ZIP. The GAIM file you pointed to is not as detailed as the log4net
Changelog
http://svn.apache.org/repos/asf/logging/log4net/trunk/ChangeLog.txt
I think that the current log4net changelog (which is built from the
checkin comments) has too much detail to be usefull. Rather than build
the changelog file from the checkin comments we should use the JIRA
issue log (which is a list of features) to compile an expanded form of
the release notes:
http://logging.apache.org/log4net/release/release-notes.html

Nicko

> -----Original Message-----
> From: Ron Grabowski [mailto:[EMAIL PROTECTED] 
> Sent: 11 December 2005 18:48
> To: Log4NET Dev
> Subject: RE: Log4net patch to fix ambiguous references in XML docs
> 
> I'm in favor of keeping the Changelog. I think its important 
> to have an offline changelog that people can quickly check. 
> It shouldn't be that difficult to take the JIRA issues and 
> copy and paste them into a changelog file.
> 
> I've been using GAIM as my instant messenger client for a 
> while. When a new version comes out I glance at this file:
> 
>  http://gaim.sourceforge.net/win32/ChangeLog.win32
> 
> I don't have to dig around on the website to find their bug 
> tracking section or create an account on an issue tracking 
> system just to take a quick peak at what changed.
> 
> --- Nicko Cadell <[EMAIL PROTECTED]> wrote:
> 
> >  
> > > -----Original Message-----
> > > From: Gert Driesen [mailto:[EMAIL PROTECTED]
> > > Sent: 11 December 2005 08:52
> > > To: Nicko Cadell
> > > Subject: RE: Log4net patch to fix ambiguous references in XML docs
> >  
> > > Are you planning on introducing ChangeLog files in each 
> directory, 
> > > or do you still plan on manually assembling a ChangeLog 
> file for the 
> > > whole project before every release ?
> > > 
> > 
> > I was thinking of dropping the changelog as the primary means of 
> > communicating the changes made between versions. I think 
> that the JIRA 
> > issue list marked as Fixed In the appropriate version gives a much 
> > more logical breakdown of the changes. It is broken up by 
> functional 
> > change and also links through to the SVN changesets. This 
> is why I am 
> > very keen on making sure that there is an issue to track 
> each feature 
> > change.
> > 
> > The disadvantages to using the JIRA issue list are that it is not a 
> > single file that can be read offline, and that it is not 
> searchable by 
> > changed file name. It is possible to get the revision history for a 
> > file in SVN and the comments should link to the issue being 
> worked on.
> > 
> > I just haven't found the Changelog file very usefull. If there is 
> > enough support for having a Changelog file then we will 
> maintain it in 
> > addition to the JIRA issues list.
> > 
> > Nicko
> > 
> 
> 
> 

Reply via email to