install: zip ChangeLog file to reduce install size

Install ChangeLog.gz zipped documentation file instead of ChangeLog to
reduce installation size (-1.5 MB).

As a result, gzip becomes mandatory when building Modules from git
repository.

Author: xdelaruelle

.aspell.en.pws

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 905
+personal_ws-1.1 en 907
 ABBRVLIST
 ActiveTcl
 Adrien
@@ -19,6 +19,7 @@ CFLAGS
 CLICOLOR
 CMake
 CONFIGLIST
+ChangeLog
 ChemAppA
 ChildModuleExists
 Coccioli
@@ -459,6 +460,7 @@ gitlog
 gmake
 grp
 gz
+gzip
 hardcode
 hdf
 homebrewed

.codespellrc

@@ -6,7 +6,7 @@
 # ignore command names used in code: uncomplete
 ignore-words-list = ans,ot,ue,fo,haa,varius,tthe,tbe,nin,desig,matchin,compre,invers,compiletime,seh,lod,nd,uncomplete
 # skip git repository internal content
-# skip generated content: ChangeLog, doc/build, modulecmd*.tcl, modules.sum
+# skip generated content: ChangeLog.gz, doc/build, modulecmd*.tcl, modules.sum
 #   modules.log, lib/config.sub, lib/config.guess
 # skip retrieved content: icdiff, lib/tcl.m4, tcl8.3.5, spack, miniconda3, OpenFOAM-dev
-skip = .git,ChangeLog,modulecmd*.tcl,*doc/build,icdiff,*lib/tcl.m4,tcl8.3.5,spack,miniconda3,OpenFOAM-dev,modules.sum,modules.log,*lib/config.sub,*lib/config.guess
+skip = .git,ChangeLog.gz,modulecmd*.tcl,*doc/build,icdiff,*lib/tcl.m4,tcl8.3.5,spack,miniconda3,OpenFOAM-dev,modules.sum,modules.log,*lib/config.sub,*lib/config.guess

.gitignore

@@ -1,5 +1,5 @@
 /modulecmd.tcl
-/ChangeLog
+/ChangeLog.gz
 /README
 /Makefile.inc
 /version.inc

INSTALL.rst

@@ -48,6 +48,7 @@ are required:
 * autopoint
 * python
 * sphinx >= 1.0
+* gzip
 
 Get Modules
 -----------

Makefile

@@ -48,7 +48,7 @@ ifneq ($(wildcard Makefile.inc),Makefile.inc)
 endif
 include Makefile.inc
 
-INSTALL_PREREQ := modulecmd.tcl ChangeLog README script/add.modules \
+INSTALL_PREREQ := modulecmd.tcl ChangeLog.gz README script/add.modules \
 	script/modulecmd
 ifeq ($(COVERAGE),y)
 TEST_PREREQ := $(MODULECMDTEST)_i $(NAGELFAR)
@@ -520,13 +520,15 @@ modulecmd.tcl: tcl/cache.tcl tcl/coll.tcl tcl/envmngt.tcl tcl/init.tcl \
 
 # generate an empty changelog file if not working from git repository
 ifeq ($(wildcard .git),.git)
-ChangeLog: script/gitlog2changelog.py
+ChangeLog.gz: script/gitlog2changelog.py
 	$(ECHO_GEN)
 	script/gitlog2changelog.py
+	gzip -f -9 ChangeLog
 else
-ChangeLog:
+ChangeLog.gz:
 	$(ECHO_GEN)
-	echo "Please refer to the NEWS document to learn about main changes" >$@
+	echo "Please refer to the NEWS document to learn about main changes" >ChangeLog
+	gzip -f -9 ChangeLog
 endif
 
 README:
@@ -662,7 +664,7 @@ endif
 ifeq ($(docinstall),y)
 	$(INSTALL_DIR) '$(DESTDIR)$(docdir)'
 	$(INSTALL_DATA) COPYING.GPLv2 '$(DESTDIR)$(docdir)/'
-	$(INSTALL_DATA) ChangeLog '$(DESTDIR)$(docdir)/'
+	$(INSTALL_DATA) ChangeLog.gz '$(DESTDIR)$(docdir)/'
 	$(INSTALL_DATA) README '$(DESTDIR)$(docdir)/'
 endif
 ifeq ($(vimaddons),y)
@@ -726,7 +728,7 @@ ifeq ($(nagelfaraddons),y)
 	-rmdir -p '$(DESTDIR)$(nagelfardatadir)'
 endif
 ifeq ($(docinstall),y)
-	rm -f $(foreach docfile,ChangeLog README COPYING.GPLv2,'$(DESTDIR)$(docdir)/$(docfile)')
+	rm -f $(foreach docfile,ChangeLog.gz README COPYING.GPLv2,'$(DESTDIR)$(docdir)/$(docfile)')
 ifeq ($(builddoc),n)
 	rmdir '$(DESTDIR)$(docdir)'
 endif
@@ -753,12 +755,12 @@ endif
 
 # include pre-generated documents not to require documentation build
 # tools when installing from dist tarball
-dist-tar: ChangeLog contrib/rpm/environment-modules.spec pkgdoc
+dist-tar: ChangeLog.gz contrib/rpm/environment-modules.spec pkgdoc
 	$(ECHO_GEN2) $(DIST_PREFIX).tar
 	git archive --prefix=$(DIST_PREFIX)/ --worktree-attributes \
 		-o $(DIST_PREFIX).tar HEAD
 	tar -rf $(DIST_PREFIX).tar --transform 's,^,$(DIST_PREFIX)/,' \
-		lib/configure lib/config.h.in $(DIST_AUTORECONF_EXTRA) ChangeLog \
+		lib/configure lib/config.h.in $(DIST_AUTORECONF_EXTRA) ChangeLog.gz \
 		doc/build/MIGRATING.txt doc/build/changes.txt doc/build/INSTALL.txt \
 		doc/build/INSTALL-win.txt doc/build/NEWS.txt doc/build/CONTRIBUTING.txt \
 		doc/build/module.1.in doc/build/ml.1 doc/build/modulefile.4 \
@@ -775,7 +777,7 @@ dist-bzip2: dist-tar
 dist: dist-gzip
 
 # dist zip ball for Windows platform with all pre-generated relevant files
-dist-win: modulecmd.tcl ChangeLog README pkgdoc
+dist-win: modulecmd.tcl ChangeLog.gz README pkgdoc
 	$(ECHO_GEN2) $(DIST_WIN_PREFIX).zip
 	$(INSTALL_DIR) $(DIST_WIN_PREFIX)
 	$(INSTALL_DIR) $(DIST_WIN_PREFIX)/libexec
@@ -786,7 +788,7 @@ dist-win: modulecmd.tcl ChangeLog README pkgdoc
 	$(INSTALL_PROGRAM) script/envml.cmd $(DIST_WIN_PREFIX)/bin/
 	$(INSTALL_DIR) $(DIST_WIN_PREFIX)/doc
 	$(INSTALL_DATA) COPYING.GPLv2 $(DIST_WIN_PREFIX)/doc/
-	$(INSTALL_DATA) ChangeLog $(DIST_WIN_PREFIX)/doc/
+	$(INSTALL_DATA) ChangeLog.gz $(DIST_WIN_PREFIX)/doc/
 	$(INSTALL_DATA) README $(DIST_WIN_PREFIX)/doc/
 	$(INSTALL_DATA) doc/build/MIGRATING.txt $(DIST_WIN_PREFIX)/doc/
 	$(INSTALL_DATA) doc/build/INSTALL-win.txt $(DIST_WIN_PREFIX)/doc/
@@ -813,7 +815,7 @@ clean:
 	rm -rf coverage
 # do not clean generated docs if not in git repository
 ifeq ($(wildcard .git),.git)
-	rm -f ChangeLog
+	rm -f ChangeLog.gz
 endif
 	rm -f README
 	rm -f modulecmd.tcl
@@ -1032,7 +1034,7 @@ $(V).SILENT: initdir pkgdoc doc version.inc contrib/rpm/environment-modules.spec
 	tcl/cache.tcl_i tcl/coll.tcl_i tcl/envmngt.tcl_i tcl/init.tcl_i \
 	tcl/main.tcl_i tcl/mfinterp.tcl_i tcl/modfind.tcl_i tcl/modeval.tcl_i \
 	tcl/modscan.tcl_i tcl/modspec.tcl_i tcl/report.tcl_i tcl/subcmd.tcl_i \
-	tcl/util.tcl_i ChangeLog README script/add.modules \
+	tcl/util.tcl_i ChangeLog.gz README script/add.modules \
 	script/gitlog2changelog.py script/modulecmd \
 	lib/libtclenvmodules$(SHLIB_SUFFIX) lib/libtestutil-closedir$(SHLIB_SUFFIX) \
 	lib/libtestutil-getpwuid$(SHLIB_SUFFIX) lib/libtestutil-getgroups$(SHLIB_SUFFIX) \

configure

@@ -963,6 +963,11 @@ else
    PYTHON=$reqpath
 fi
 
+# gzip is mandatory if installing from git repository to build ChangeLog.gz
+if [ -e '.git' ]; then
+   check_requirement gzip
+fi
+
 # get location of commands used 'fullpath' in init scripts
 check_requirement 'ps' '' "PATH=$binsearchpath"
 # shellcheck disable=SC2034

contrib/rpm/environment-modules.spec.in

@@ -181,7 +181,7 @@ fi
 %else
 %license COPYING.GPLv2
 %endif
-%doc ChangeLog README NEWS.txt MIGRATING.txt INSTALL.txt CONTRIBUTING.txt changes.txt
+%doc ChangeLog.gz README NEWS.txt MIGRATING.txt INSTALL.txt CONTRIBUTING.txt changes.txt
 %{_sysconfdir}/modulefiles
 %if 0%{?fedora}
 %ghost %{_sysconfdir}/profile.d/modules.csh