# # Makefile for LCOV # # Make targets: # - install: install LCOV tools and man pages on the system # - uninstall: remove tools and man pages from the system # - dist: create files required for distribution, i.e. the lcov.tar.gz # and the lcov.rpm file. Just make sure to adjust the VERSION # and RELEASE variables below - both version and date strings # will be updated in all necessary files. # - checkstyle: check source files for coding style issues # MODE=(full|diff) [UPDATE=1] # - clean: remove all generated files # - release: finalize release and create git tag for specified VERSION # - test: run regression tests. # additional Make variables: # COVERGAGE=1 # - enable perl coverage data collection # TESTCASE_ARGS=string # - pass these arguments to testcase script # Sample args: # --update - overwrite GOLD file with # result # --parallel n - use --parallel flag # --home path - path to lcov script # --llvm - use LLVM rather than gcc # --keep-going - don't stop on error # --verbose - echo commands to test.log # Note that not all tests have been updated to use # all flags VERSION := $(shell bin/get_version.sh --version) RELEASE := $(shell bin/get_version.sh --release) FULL := $(shell bin/get_version.sh --full) # Set this variable during 'make install' to specify the interpreters used in # installed scripts, or leave empty to keep the current interpreter. export LCOV_PERL_PATH := /usr/bin/perl export LCOV_PYTHON_PATH := /usr/bin/python3 PREFIX := /usr/local FIRST_CHAR = $(shell echo "$(DESTDIR)$(PREFIX)" | cut -c 1) ifneq ("$(FIRST_CHAR)", "/") $(error "DESTDIR + PREFIX expected to be absolute path - found $(FIRST_CHAR)") endif CFG_DIR := $(PREFIX)/etc BIN_DIR := $(PREFIX)/bin LIB_DIR := $(PREFIX)/lib/lcov MAN_DIR := $(PREFIX)/share/man SHARE_DIR := $(PREFIX)/share/lcov/ SCRIPT_DIR := $(SHARE_DIR)/support-scripts CFG_INST_DIR := $(DESTDIR)$(CFG_DIR) BIN_INST_DIR := $(DESTDIR)$(BIN_DIR) LIB_INST_DIR := $(DESTDIR)$(LIB_DIR) MAN_INST_DIR := $(DESTDIR)$(MAN_DIR) SHARE_INST_DIR := $(DESTDIR)$(SHARE_DIR) SCRIPT_INST_DIR := $(SHARE_INST_DIR)/support-scripts TMP_DIR := $(shell mktemp -d) FILES := README Makefile lcovrc \ $(wildcard bin/*) $(wildcard example/*) $(wildcard lib/*) \ $(wildcard man/*) $(wildcard rpm/*) $(wildcard scripts/*) DIST_CONTENT := CONTRIBUTING COPYING README Makefile lcovrc \ bin example lib man rpm scripts tests EXES = \ lcov genhtml geninfo genpng gendesc \ perl2lcov py2lcov xml2lcov xml2lcovutil.py \ llvm2lcov # there may be both public and non-public user scripts - so lets not show # any of their names SCRIPTS = $(shell ls scripts | grep -v -E '([\#\~]|\.orig|\.bak|\.BAK)' ) LIBS = lcovutil.pm MAN_SECTIONS = 1 5 # similarly, lets not talk about man pages MANPAGES = $(foreach s, $(MAN_SECTIONS), $(foreach m, $(shell cd man ; ls *.$(s)), man$(s)/$(m))) # Program for checking coding style CHECKSTYLE = $(CURDIR)/bin/checkstyle.sh INSTALL = install FIX = $(realpath bin/fix.pl) RM = rm -f RMDIR = rmdir export V ifeq ("${V}","1") echocmd= else echocmd=echo $1 ; .SILENT: endif .PHONY: all info clean install uninstall rpms test all: info info: @echo "Available make targets:" @echo " install : install binaries and man pages in DESTDIR (default /)" @echo " uninstall : delete binaries and man pages from DESTDIR (default /)" @echo " dist : create packages (RPM, tarball) ready for distribution" @echo " check : perform self-tests" @echo " checkstyle: check source files for coding style issues" @echo " release : finalize release and create git tag for specified VERSION" @echo " test : same as 'make check'" clean: $(call echocmd," CLEAN lcov") $(RM) lcov-*.tar.gz lcov-*.rpm $(RM) -r ./bin/__pycache__ $(MAKE) -C example -s clean $(MAKE) -C tests -s clean find . -name '*.tdy' -o -name '*.orig' | xargs rm -f install: $(INSTALL) -d -m 755 $(BIN_INST_DIR) for b in $(EXES) ; do \ $(call echocmd," INSTALL $(BIN_INST_DIR)/$$b") \ $(INSTALL) -m 755 bin/$$b $(BIN_INST_DIR)/$$b ; \ $(FIX) --version $(VERSION) --release $(RELEASE) \ --libdir $(LIB_DIR) --bindir $(BIN_DIR) \ --fixver --fixlibdir --fixbindir \ --exec $(BIN_INST_DIR)/$$b ; \ done $(INSTALL) -d -m 755 $(SCRIPT_INST_DIR) for s in $(SCRIPTS) ; do \ $(call echocmd," INSTALL $(SCRIPT_INST_DIR)/$$s") \ $(INSTALL) -m 755 scripts/$$s $(SCRIPT_INST_DIR)/$$s ; \ $(FIX) --version $(VERSION) --release $(RELEASE) \ --libdir $(LIB_DIR) --bindir $(BIN_DIR) \ --fixver --fixlibdir \ --fixscriptdir --scriptdir $(SCRIPT_DIR) \ --exec $(SCRIPT_INST_DIR)/$$s ; \ done $(INSTALL) -d -m 755 $(LIB_INST_DIR) for l in $(LIBS) ; do \ $(call echocmd," INSTALL $(LIB_INST_DIR)/$$l") \ $(INSTALL) -m 644 lib/$$l $(LIB_INST_DIR)/$$l ; \ $(FIX) --version $(VERSION) --release $(RELEASE) \ --libdir $(LIB_DIR) --bindir $(BIN_DIR) \ --fixver --fixlibdir --fixbindir \ --exec $(LIB_INST_DIR)/$$l ; \ done for section in $(MAN_SECTIONS) ; do \ DEST=$(MAN_INST_DIR)/man$$section ; \ $(INSTALL) -d -m 755 $$DEST ; \ for m in man/*.$$section ; do \ F=`basename $$m` ; \ $(call echocmd," INSTALL $$DEST/$$F") \ $(INSTALL) -m 644 man/$$F $$DEST/$$F ; \ $(FIX) --version $(VERSION) --fixver --fixdate \ --fixscriptdir --scriptdir $(SCRIPT_DIR) \ --manpage $$DEST/$$F ; \ done ; \ done mkdir -p $(SHARE_INST_DIR) for d in example tests ; do \ ( cd $$d ; make clean ) ; \ find $$d -type d -exec mkdir -p "$(SHARE_INST_DIR){}" \; ; \ find $$d -type f -exec $(INSTALL) -Dm 644 "{}" "$(SHARE_INST_DIR){}" \; ; \ done ; @chmod -R ugo+x $(SHARE_INST_DIR)/tests/bin @find $(SHARE_INST_DIR)/tests \( -name '*.sh' -o -name '*.pl' \) -exec chmod ugo+x {} \; $(INSTALL) -d -m 755 $(CFG_INST_DIR) $(call echocmd," INSTALL $(CFG_INST_DIR)/lcovrc") $(INSTALL) -m 644 lcovrc $(CFG_INST_DIR)/lcovrc $(call echocmd," done INSTALL") uninstall: for b in $(EXES) ; do \ $(call echocmd," UNINST $(BIN_INST_DIR)/$$b") \ $(RM) $(BIN_INST_DIR)/$$b ; \ done $(RMDIR) $(BIN_INST_DIR) || true # .../lib/lcov installed by us - so safe to remove $(call echocmd," UNINST $(LIB_INST_DIR)") $(RM) -r $(LIB_INST_DIR) $(call echocmd," UNINST $(shell dirname $(LIB_INST_DIR)) (if empty)") $(RMDIR) `dirname $(LIB_INST_DIR)` || true # .../share/lcov installed by us - so safe to remove $(call echocmd," UNINST $(SHARE_INST_DIR)") $(RM) -r $(SHARE_INST_DIR) $(call echocmd," UNINST $(MAN_INST_DIR) pages") for section in $(MAN_SECTIONS) ; do \ DEST=$(MAN_INST_DIR)/man$$section ; \ for m in man/*.$$section ; do \ F=`basename $$m` ; \ $(RM) $$DEST/$$F ; \ done ; \ $(RMDIR) $$DEST || true; \ done $(call echocmd," UNINST $(MAN_INST_DIR) (if empty)") $(RMDIR) $(MAN_INST_DIR) || true; $(call echocmd," UNINST $(shell dirname $(SHARE_INST_DIR)) (if empty)") $(RMDIR) `dirname $(SHARE_INST_DIR)` $(call echocmd," UNINST $(CFG_INST_DIR)/lcovrc") $(RM) $(CFG_INST_DIR)/lcovrc $(RMDIR) $(CFG_INST_DIR) || true $(call echocmd," UNINST $(DESTDIR)/$(PREFIX)") $(RMDIR) $(DESTDIR)$(PREFIX) || true dist: lcov-$(VERSION).tar.gz lcov-$(VERSION)-$(RELEASE).noarch.rpm \ lcov-$(VERSION)-$(RELEASE).src.rpm lcov-$(VERSION).tar.gz: $(FILES) $(call echocmd," DIST lcov-$(VERSION).tar.gz") $(RM) -r $(TMP_DIR)/lcov-$(VERSION) mkdir -p $(TMP_DIR)/lcov-$(VERSION) cp -r $(DIST_CONTENT) $(TMP_DIR)/lcov-$(VERSION) ./bin/copy_dates.sh . $(TMP_DIR)/lcov-$(VERSION) $(MAKE) -s -C $(TMP_DIR)/lcov-$(VERSION) clean >/dev/null cd $(TMP_DIR)/lcov-$(VERSION) ; \ $(FIX) --version $(VERSION) --release $(RELEASE) \ --verfile .version --fixver --fixdate \ $(patsubst %,bin/%,$(EXES)) $(patsubst %,scripts/%,$(SCRIPTS)) \ $(patsubst %,lib/%,$(LIBS)) \ $(patsubst %,man/%,$(notdir $(MANPAGES))) README rpm/lcov.spec ./bin/get_changes.sh > $(TMP_DIR)/lcov-$(VERSION)/CHANGES || true cd $(TMP_DIR) ; \ tar cfz $(TMP_DIR)/lcov-$(VERSION).tar.gz lcov-$(VERSION) \ --owner root --group root mv $(TMP_DIR)/lcov-$(VERSION).tar.gz . $(RM) -r $(TMP_DIR) lcov-$(VERSION)-$(RELEASE).noarch.rpm: rpms lcov-$(VERSION)-$(RELEASE).src.rpm: rpms rpms: lcov-$(VERSION).tar.gz $(call echocmd," DIST lcov-$(VERSION)-$(RELEASE).noarch.rpm") mkdir -p $(TMP_DIR) mkdir $(TMP_DIR)/BUILD mkdir $(TMP_DIR)/RPMS mkdir $(TMP_DIR)/SOURCES mkdir $(TMP_DIR)/SRPMS cp lcov-$(VERSION).tar.gz $(TMP_DIR)/SOURCES ( \ cd $(TMP_DIR)/BUILD ; \ tar xfz ../SOURCES/lcov-$(VERSION).tar.gz \ lcov-$(VERSION)/rpm/lcov.spec \ ) rpmbuild --define '_topdir $(TMP_DIR)' --define '_buildhost localhost' \ --define "_target_os linux" \ --undefine vendor --undefine packager \ -ba $(TMP_DIR)/BUILD/lcov-$(VERSION)/rpm/lcov.spec --quiet mv $(TMP_DIR)/RPMS/noarch/lcov-$(VERSION)-$(RELEASE).noarch.rpm . $(call echocmd," DIST lcov-$(VERSION)-$(RELEASE).src.rpm") mv $(TMP_DIR)/SRPMS/lcov-$(VERSION)-$(RELEASE).src.rpm . $(RM) -r $(TMP_DIR) ifeq ($(COVERAGE), 1) # write to .../tests/cover_db export COVER_DB := $(shell echo `pwd`/tests/cover_db) export PYCOV_DB := $(shell echo `pwd`/tests/pycov.dat) export HTML_RPT := $(shell echo `pwd`/lcov_coverage) #export LCOV_FORCE_PARALLEL = 1 endif export TESTCASE_ARGS test: check # for COVERAGE mode check: run once with LCOV_FORCE_PARALLEL=1 and # once without - so we can merge the result check: if [ "x$(COVERAGE)" != 'x' ] ; then \ if [ ! -d $(COVER_DB) ]; then \ mkdir $(COVER_DB) ; \ fi ; \ echo "*** Run once, force parallel ***" ; \ LCOV_FORCE_PARALLEL=1 $(MAKE) -s -C tests check LCOV_HOME=`pwd` ; \ echo "*** Run again, no force ***" ; \ fi @$(MAKE) -s -C tests check LCOV_HOME=`pwd` @if [ "x$(COVERAGE)" != 'x' ] ; then \ $(MAKE) -s -C example LCOV_HOME=`pwd`; \ $(MAKE) -s -C tests report ; \ fi # Files to be checked for coding style issue issues - # - anything containing "#!/usr/bin/env perl" or the like # - anything named *.pm - expected to be perl module # ... as long as the name doesn't end in .tdy or .orig checkstyle: ifeq ($(MODE),full) @echo "Checking source files for coding style issues (MODE=full):" else @echo "Checking changes in source files for coding style issues (MODE=diff):" endif @RC=0 ; \ CHECKFILES=`find . -path ./.git -prune -o \( \( -type f -exec grep -q '^#!.*perl' {} \; \) -o -name '*.pm' \) -not \( -name '*.tdy' -o -name '*.orig' -o -name '*~' \) -print `; \ for FILE in $$CHECKFILES ; do \ $(CHECKSTYLE) "$$FILE"; \ if [ 0 != $$? ] ; then \ RC=1; \ echo "saw mismatch for $$FILE"; \ if [ -f $$FILE.tdy -a "$(UPDATE)x" != 'x' ]; then \ echo "updating $$FILE"; \ mv $$FILE $$FILE.orig; \ mv $$FILE.tdy $$FILE ; \ fi \ fi \ done ; \ exit $$RC release: @if [ "$(origin VERSION)" != "command line" ] ; then echo "Please specify new version number, e.g. VERSION=1.16" >&2 ; exit 1 ; fi @if [ -n "$$(git status --porcelain 2>&1)" ] ; then echo "The repository contains uncommitted changes" >&2 ; exit 1 ; fi @if [ -n "$$(git tag -l v$(VERSION))" ] ; then echo "A tag for the specified version already exists (v$(VERSION))" >&2 ; exit 1 ; fi @echo "Preparing release tag for version $(VERSION)" git checkout master bin/copy_dates.sh . . $(FIX) --version $(VERSION) --release $(RELEASE) \ --fixver --fixdate $(patsubst %,man/%,$(notdir $(MANPAGES))) \ README rpm/lcov.spec git commit -a -s -m "lcov: Finalize release $(VERSION)" git tag v$(VERSION) -m "LCOV version $(VERSION)" @echo "**********************************************" @echo "Release tag v$(VERSION) successfully created" @echo "Next steps:" @echo " - Review resulting commit and tag" @echo " - Publish with: git push origin master v$(VERSION)" @echo "**********************************************"