[bind10-dev] NEWS vs. ChangeLog

Jeremy C. Reed jreed at isc.org
Fri Jan 25 15:37:28 UTC 2013


At a recent conference call, we discussed a little about purpose of 
ChangeLog and NEWS file.

I made a quick branch:  trac2660

This moved the ChangeLog to NEWS.

And then added a make target to generate the ChangeLog from the git 
commit message history.  This was based on code used by the X.org 
project.

One minor problem is that the ChangeLog is huge. (X.org at least is 
split up into many, many, components, so some changelogs are small. But 
as a comparison, libX11 ChangeLog is near 1MB and xorg-server is 3MB.) 
The BIND10 ChangeLog is 3MB. Our tarball is currently around 5MB. This 
will bring it to around 6MB I estimate.  The ChangeLog would not be kept 
in the git repo, just in the "dist" generated tarballs.

(I'd like to extend the changelog generation to put at the top: "See the 
NEWS file for summaries of important changes.")

The NEWS file would include the summaries of noticable changes or 
other important news like we already do. It is re-used for release 
announcements also.

Any comments or thoughts on this?

  Jeremy C. Reed
  ISC


More information about the bind10-dev mailing list