maint: Stop generating ChangeLog from git

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@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Andrea Bolognani 2019-04-01 17:33:03 +02:00
parent 241a0e8c8b
commit ce97c33a79
5 changed files with 19 additions and 17 deletions

1
.gitignore vendored
View File

@ -37,7 +37,6 @@
.sc-start-sc_* .sc-start-sc_*
.ycm_extra_conf.py .ycm_extra_conf.py
/AUTHORS /AUTHORS
/ChangeLog
/GNUmakefile /GNUmakefile
/INSTALL /INSTALL
/NEWS /NEWS

15
ChangeLog Normal file
View File

@ -0,0 +1,15 @@
libvirt ChangeLog
=================
The libvirt project doesn't include a detailed ChangeLog in its release
archives.
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

View File

@ -79,19 +79,7 @@ check-access:
MAINTAINERCLEANFILES = .git-module-status MAINTAINERCLEANFILES = .git-module-status
dist-hook: gen-ChangeLog gen-AUTHORS dist-hook: gen-AUTHORS
# Generate the ChangeLog file (with all entries since the switch to git)
# and insert it into the directory we're about to use to create a tarball.
gen_start_date = 2009-07-04
.PHONY: gen-ChangeLog
gen-ChangeLog:
$(AM_V_GEN)if test -d .git; then \
$(top_srcdir)/build-aux/gitlog-to-changelog \
--since=$(gen_start_date) > $(distdir)/cl-t; \
rm -f $(distdir)/ChangeLog; \
mv $(distdir)/cl-t $(distdir)/ChangeLog; \
fi
.PHONY: gen-AUTHORS .PHONY: gen-AUTHORS
gen-AUTHORS: gen-AUTHORS:

View File

@ -176,8 +176,8 @@ xmllint -
xsltproc - xsltproc -
" "
# Automake requires that ChangeLog and AUTHORS exist. # Automake requires that AUTHORS exist.
touch AUTHORS ChangeLog || exit 1 touch AUTHORS || exit 1
# Override bootstrap's list - we don't use mdate-sh or texinfo.tex. # Override bootstrap's list - we don't use mdate-sh or texinfo.tex.
gnulib_extra_files=" gnulib_extra_files="

2
cfg.mk
View File

@ -1113,7 +1113,7 @@ maint.mk Makefile: _autogen_error
# though, as it would be quite pointless # though, as it would be quite pointless
ifeq (2,$(_dry_run_result)$(_clean_requested)) ifeq (2,$(_dry_run_result)$(_clean_requested))
$(info INFO: running autogen.sh is required, running it now...) $(info INFO: running autogen.sh is required, running it now...)
$(shell touch $(srcdir)/AUTHORS $(srcdir)/ChangeLog) $(shell touch $(srcdir)/AUTHORS)
maint.mk Makefile: _autogen maint.mk Makefile: _autogen
endif endif
endif endif