[libvirt] [PATCH 1/3] maint: Stop generating ChangeLog from git

[Daniel P. Berrangé]

On Tue, Apr 02, 2019 at 12:43:33PM +0200, Ján Tomko wrote:
> On Mon, Apr 01, 2019 at 06:50:51PM +0200, Andrea Bolognani wrote:
> > Our ChangeLog is generated by basically redirecting the output
> > of 'git log' into it so, as can be expected, it has only gotten
> > bigger as development has progressed. As of today, its size has
> > reached pretty much comical levels:
> > 
> >  $ du -sk ChangeLog
> >  11328 ChangeLog
> > 
> > All of that for information *literally nobody* cares about: end
> > users and distro maintainers have proper release notes lovingly
> > compiled for them, while developers peruse the history either by
> > calling 'git log' directly or through their favorite $EDITOR's
> > git integration.
> > 
> > Replacing the generated ChangeLog with a short message pointing
> > interested parties to the git repository does not only reduce
> > the size of the unpacked sources from 259904 KiB to 248576 KiB
> > (~4% saving): from a quick test on my laptop, doing so reduces
> > the size of the *compressed* release archive from 15140 KiB to
> > 12364 KiB (~18% saving) and also takes the time needed to run
> > 'make distcheck' down from 4:44 to 4:21 (~8% saving).
> > 
> > Signed-off-by: Andrea Bolognani <abologna at redhat.com>
> > ---
> > .gitignore     |  1 -
> > ChangeLog      | 15 +++++++++++++++
> > Makefile.am    | 14 +-------------
> > bootstrap.conf |  4 ++--
> > cfg.mk         |  2 +-
> > 5 files changed, 19 insertions(+), 17 deletions(-)
> > create mode 100644 ChangeLog
> > 
> > diff --git a/.gitignore b/.gitignore
> > index 3223cf1b76..c918ec8226 100644
> > --- a/.gitignore
> > +++ b/.gitignore
> > @@ -37,7 +37,6 @@
> > .sc-start-sc_*
> > .ycm_extra_conf.py
> > /AUTHORS
> > -/ChangeLog
> > /GNUmakefile
> > /INSTALL
> > /NEWS
> > diff --git a/ChangeLog b/ChangeLog
> > new file mode 100644
> > index 0000000000..55eb05c5ce
> > --- /dev/null
> > +++ b/ChangeLog
> > @@ -0,0 +1,15 @@
> > +libvirt ChangeLog
> > +=================
> > +
> > +The libvirt project doesn't include a detailed ChangeLog in its release
> > +archives.
> > +
> 
> This says we don't have a proper changelog
> 
> > +If you're interested in the full list of changes made to libvirt since
> > +the project was started, you can clone the git repository from
> > +
> > +  https://libvirt.org/git/libvirt.git
> > +
> > +and browse them locally using your favorite git history viewer or,
> > +alternatively, browse them online at
> > +
> > +  https://libvirt.org/git/?p=libvirt.git;a=log
> 
> And this points the developer to the libvirt.git, which is already
> linked in README-hacking
> 
> I'd rather drop the ChangeLog file completely

autotools requires that it exists and I think having this general
text is better than shipping a zero length file.


Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|