1 # Maintainer makefile rules for Automake.
3 # Copyright (C) 1995-2013 Free Software Foundation, Inc.
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2, or (at your option)
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 # Avoid CDPATH issues.
21 # Program to use to fetch files from the Net.
24 # --------------------------------------------------------- #
25 # Automatic generation of the ChangeLog from git history. #
26 # --------------------------------------------------------- #
28 gitlog_to_changelog_command = $(PERL) $(srcdir)/lib/gitlog-to-changelog
29 gitlog_to_changelog_fixes = $(srcdir)/.git-log-fix
30 gitlog_to_changelog_options = --amend=$(gitlog_to_changelog_fixes) \
31 --since='2011-12-28 00:00:00' \
32 --no-cluster --format '%s%n%n%b'
34 EXTRA_DIST += lib/gitlog-to-changelog
35 EXTRA_DIST += $(gitlog_to_changelog_fixes)
37 # When executed from a git checkout, generate the ChangeLog from the git
38 # history. When executed from an extracted distribution tarball, just
39 # copy the distributed ChangeLog in the build directory (and if this
40 # fails, or if no distributed ChangeLog file is present, complain and
43 # The ChangeLog should be regenerated unconditionally when working from
44 # checked-out sources; otherwise, if we're working from a distribution
45 # tarball, we expect the ChangeLog to be distributed, so check that it
46 # is indeed present in the source directory.
48 $(AM_V_GEN)set -e; set -u; \
49 if test -d $(srcdir)/.git; then \
51 && $(gitlog_to_changelog_command) \
52 $(gitlog_to_changelog_options) >$@-t \
56 elif test ! -f $(srcdir)/$@; then \
57 echo "Source tree is not a git checkout, and no pre-existent" \
58 "$@ file has been found there" >&2; \
64 # --------------------------- #
65 # Perl coverage statistics. #
66 # --------------------------- #
68 PERL_COVERAGE_DB = $(abs_top_builddir)/cover_db
69 PERL_COVERAGE_FLAGS = -MDevel::Cover=-db,$(PERL_COVERAGE_DB),-silent,on,-summary,off
72 check-coverage-run recheck-coverage-run: %-coverage-run: all
73 $(MKDIR_P) $(PERL_COVERAGE_DB)
74 PERL5OPT="$$PERL5OPT $(PERL_COVERAGE_FLAGS)"; export PERL5OPT; \
75 WANT_NO_THREADS=yes; export WANT_NO_THREADS; unset AUTOMAKE_JOBS; \
78 check-coverage-report:
79 @if test ! -d "$(PERL_COVERAGE_DB)"; then \
80 echo "No coverage database found in '$(PERL_COVERAGE_DB)'." >&2; \
81 echo "Please run \"make check-coverage\" first" >&2; \
84 $(PERL_COVER) $(PERL_COVER_FLAGS) "$(PERL_COVERAGE_DB)"
86 # We don't use direct dependencies here because we'd like to be able
87 # to invoke the report even after interrupted check-coverage.
88 check-coverage: check-coverage-run
89 $(MAKE) check-coverage-report
91 recheck-coverage: recheck-coverage-run
92 $(MAKE) check-coverage-report
95 rm -rf "$(PERL_COVERAGE_DB)"
96 clean-local: clean-coverage
98 .PHONY: check-coverage recheck-coverage check-coverage-run \
99 recheck-coverage-run check-coverage-report clean-coverage
102 # ---------------------------------------------------- #
103 # Tagging and/or uploading stable and beta releases. #
104 # ---------------------------------------------------- #
108 EXTRA_DIST += lib/gnupload
110 # First component of a version number (mandatory).
112 # Later components of a version number (optional).
114 # Used in recipes to decide which kind of release we are.
115 stable_major_version_rx = $(rx-0)\.0$$
116 stable_minor_version_rx = $(rx-0)$(rx-1)$$
117 stable_micro_version_rx = $(rx-0)$(rx-1)$(rx-1)$$
118 beta_version_rx = $(rx-0)($(rx-1)){1,2}[bdfhjlnprtvxz]$$
119 alpha_version_rx = $(rx-0)($(rx-1)){1,2}[acegikmoqsuwy]$$
120 match_version = echo "$(VERSION)" | $(EGREP) >/dev/null
122 # Check that we don't have uncommitted or unstaged changes.
123 # TODO: Maybe the git suite already offers a shortcut to verify if the
124 # TODO: working directory is "clean" or not? If yes, use that instead
125 # TODO: of duplicating the logic here.
126 git_must_have_clean_workdir = \
127 $(GIT) rev-parse --verify HEAD >/dev/null \
128 && $(GIT) update-index -q --refresh \
129 && $(GIT) diff-files --quiet \
130 && $(GIT) diff-index --quiet --cached HEAD \
131 || { echo "$@: you have uncommitted or unstaged changes" >&2; exit 1; }
133 determine_release_type = \
134 if $(match_version) '$(stable_major_version_rx)'; then \
135 release_type='Major release'; \
136 announcement_type='major release'; \
138 elif $(match_version) '$(stable_minor_version_rx)'; then \
139 release_type='Minor release'; \
140 announcement_type='minor release'; \
142 elif $(match_version) '$(stable_micro_version_rx)'; then \
143 release_type='Micro release'; \
144 announcement_type='maintenance release'; \
146 elif $(match_version) '$(beta_version_rx)'; then \
147 release_type='Beta release'; \
148 announcement_type='test release'; \
150 elif $(match_version) '$(alpha_version_rx)'; then \
151 echo "$@: improper version '$(VERSION)' for a release" >&2; \
152 if test -n '$(strip $(DEVEL_SNAPSHOT))'; then \
153 echo "$@: continuing anyway since DEVEL_SNAPSHOT is set" >&2; \
154 release_type='Development snapshot'; \
155 announcement_type='development snapshot'; \
161 echo "$@: invalid version number '$(VERSION)'" >&2; \
165 # Help the debugging of $(determine_release_type) and related code.
167 @$(determine_release_type); \
168 echo "$$release_type $(VERSION);" \
169 "it will be announced as a \"$$announcement_type\""
171 git-tag-release: maintainer-check
173 case '$(AM_TAG_DRYRUN)' in \
174 ""|[nN]|[nN]o|NO) run="";; \
175 *) run="echo Running:";; \
177 $(determine_release_type); \
178 $(git_must_have_clean_workdir); \
179 $$run $(GIT) tag -s "v$(VERSION)" -m "$$release_type $(VERSION)"
182 @# Check this is a version we can cut a release (either test
184 @$(determine_release_type)
185 @# The repository must be clean.
186 @$(git_must_have_clean_workdir)
187 @# Check that we are releasing from a valid tag.
188 @tag=`$(GIT) describe` \
189 && case $$tag in "v$(VERSION)") true;; *) false;; esac \
190 || { echo "$@: you can only create a release from a tagged" \
193 @# Build the distribution tarball(s).
195 @# Upload it to the correct FTP repository.
196 @$(determine_release_type) \
197 && dest=$$dest.gnu.org:automake \
198 && echo "Will upload to $$dest: $(DIST_ARCHIVES)" \
199 && $(srcdir)/lib/gnupload $(GNUPLOADFLAGS) --to $$dest \
202 .PHONY: print-release-type git-upload-release git-tag-release
205 # ------------------------------------------------------------------ #
206 # Explore differences of autogenerated files in different commits. #
207 # ------------------------------------------------------------------ #
209 # Visually comparing differences between the Makefile.in files in
210 # automake's own build system as generated in two different branches
211 # might help to catch bugs and blunders. This has already happened a
212 # few times in the past, when we used to version-control Makefile.in.
215 NEW_COMMIT=$${NEW_COMMIT-"HEAD"}; \
216 OLD_COMMIT=$${OLD_COMMIT-"HEAD~1"}; \
217 am_gitdir='$(abs_top_srcdir)/.git'; \
218 get_autofiles_from_rev () \
221 && echo "$@: will get files from revision $$rev" \
222 && $(GIT) clone -q --depth 1 "$$am_gitdir" tmp \
224 && $(GIT) checkout -q "$$rev" \
225 && echo "$@: bootstrapping $$rev" \
226 && $(SHELL) ./bootstrap.sh \
227 && echo "$@: copying files from $$rev" \
228 && makefile_ins=`find . -name Makefile.in` \
229 && (tar cf - configure aclocal.m4 $$makefile_ins) | \
230 (cd .. && cd "$$dir" && tar xf -) \
235 && : Before proceeding, ensure the specified revisions truly exist. \
236 && $(GIT) --git-dir="$$am_gitdir" describe $$OLD_COMMIT >/dev/null \
237 && $(GIT) --git-dir="$$am_gitdir" describe $$NEW_COMMIT >/dev/null \
242 && get_autofiles_from_rev $$OLD_COMMIT old \
243 && get_autofiles_from_rev $$NEW_COMMIT new \
246 # With lots of eye candy; we like our developers pampered and spoiled :-)
247 compare-autodiffs: autodiffs
249 : $${COLORDIFF=colordiff} $${DIFF=diff}; \
251 if test ! -d "$$dir"; then \
252 echo "$@: $$dir: Not a directory" >&2; \
255 mydiff=false mypager=false; \
257 if ($$COLORDIFF -r . .) </dev/null >/dev/null 2>&1; then \
258 mydiff=$$COLORDIFF; \
266 if test "$$mydiff" = false; then \
267 if ($$DIFF -r -u . .); then \
270 echo "$@: no good-enough diff program specified" >&2; \
274 st=0; $$mydiff -r -u $$dir/old $$dir/new | $$mypager || st=$$?; \
277 .PHONY: autodiffs compare-autodiffs
279 # ---------------------------------------------- #
280 # Help writing the announcement for a release. #
281 # ---------------------------------------------- #
283 PACKAGE_MAILINGLIST = automake@gnu.org
285 announcement: DEVEL_SNAPSHOT = yes
289 && $(determine_release_type) \
290 && ftp_base="ftp://$$dest.gnu.org/gnu/$(PACKAGE)" \
291 && X () { printf '%s\n' "$$*" >> $@-t; } \
292 && X "We are pleased to announce the $(PACKAGE_NAME) $(VERSION)" \
293 "$$announcement_type." \
295 && X "**TODO** Brief description of the release here." \
297 && X "**TODO** This description can span multiple paragraphs." \
299 && X "See below for the detailed list of changes since the" \
300 && X "previous version, as summarized by the NEWS file." \
302 && X "Download here:" \
304 && X " $$ftp_base/$(PACKAGE)-$(VERSION).tar.gz" \
305 && X " $$ftp_base/$(PACKAGE)-$(VERSION).tar.xz" \
307 && X "Please report bugs and problems to" \
308 "<$(PACKAGE_BUGREPORT)>," \
309 && X "and send general comments and feedback to" \
310 "<$(PACKAGE_MAILINGLIST)>." \
312 && X "Thanks to everyone who has reported problems, contributed" \
313 && X "patches, and helped testing Automake!" \
318 ($$0 ~ /^New in .*:/) { wait_for_end=1; } \
319 (/^~~~/ && wait_for_end) { print; exit(0) } \
321 ' <$(srcdir)/NEWS >> $@-t \
324 CLEANFILES += announcement
326 # --------------------------------------------------------------------- #
327 # Synchronize third-party files that are committed in our repository. #
328 # --------------------------------------------------------------------- #
330 # Git repositories on Savannah.
331 git-sv-host = git.savannah.gnu.org
333 # Some repositories we sync files from.
334 SV_CVS = 'http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/'
335 SV_GIT_CF = 'http://$(git-sv-host)/gitweb/?p=config.git;a=blob_plain;hb=HEAD;f='
336 SV_GIT_AC = 'http://$(git-sv-host)/gitweb/?p=autoconf.git;a=blob_plain;hb=HEAD;f='
337 SV_GIT_GL = 'http://$(git-sv-host)/gitweb/?p=gnulib.git;a=blob_plain;hb=HEAD;f='
339 # Files that we fetch and which we compare against.
340 # Note that the 'lib/COPYING' file must still be synced by hand.
342 $(SV_GIT_CF)config.guess \
343 $(SV_GIT_CF)config.sub \
344 $(SV_CVS)texinfo/texinfo/doc/texinfo.tex \
345 $(SV_CVS)texinfo/texinfo/util/gendocs.sh \
346 $(SV_CVS)texinfo/texinfo/util/gendocs_template \
347 $(SV_GIT_GL)build-aux/gitlog-to-changelog \
348 $(SV_GIT_GL)build-aux/gnupload \
349 $(SV_GIT_GL)build-aux/update-copyright \
350 $(SV_GIT_GL)doc/INSTALL
352 # Fetch the latest versions of few scripts and files we care about.
353 # A retrieval failure or a copying failure usually mean serious problems,
354 # so we'll just bail out if 'wget' or 'cp' fail.
356 $(AM_V_at)rm -rf Fetchdir
357 $(AM_V_at)mkdir Fetchdir
359 if $(AM_V_P); then wget_opts=; else wget_opts=-nv; fi; \
360 for url in $(FETCHFILES); do \
361 file=`printf '%s\n' "$$url" | sed 's|^.*/||; s|^.*=||'`; \
362 $(WGET) $$wget_opts "$$url" -O Fetchdir/$$file || exit 1; \
363 if cmp Fetchdir/$$file $(srcdir)/lib/$$file >/dev/null; then \
366 echo "$@: updating file $$file"; \
367 cp Fetchdir/$$file $(srcdir)/lib/$$file || exit 1; \
370 $(AM_V_at)rm -rf Fetchdir
373 # ---------------------------------------------------------------------- #
374 # Generate and upload manuals in several formats, for the GNU website. #
375 # ---------------------------------------------------------------------- #
377 web_manual_dir = doc/web-manual
383 WEBCVS_ROOT = cvs.savannah.gnu.org:/web
387 .PHONY: web-manual web-manual-update
388 web-manual web-manual-update: t = $@.dir
390 # Build manual in several formats. Note to the recipe:
391 # 1. The symlinking of automake.texi into the temporary directory is
392 # required to pacify extra checks from gendocs.sh.
393 # 2. The redirection to /dev/null before the invocation of gendocs.sh
394 # is done to better respect silent rules.
396 $(AM_V_at)rm -rf $(web_manual_dir) $t
398 $(AM_V_at)$(LN_S) '$(abs_srcdir)/doc/$(PACKAGE).texi' '$t/'
400 && GENDOCS_TEMPLATE_DIR='$(abs_srcdir)/lib' \
401 && export GENDOCS_TEMPLATE_DIR \
402 && if $(AM_V_P); then :; else exec >/dev/null 2>&1; fi \
403 && $(SHELL) '$(abs_srcdir)/lib/gendocs.sh' \
404 -I '$(abs_srcdir)/doc' --email $(PACKAGE_BUGREPORT) \
405 $(PACKAGE) '$(PACKAGE_NAME)'
406 $(AM_V_at)mkdir $(web_manual_dir)
407 $(AM_V_at)mv -f $t/manual/* $(web_manual_dir)
409 @! $(AM_V_P) || ls -l $(web_manual_dir)
411 # Upload manual to www.gnu.org, using CVS (sigh!)
413 $(AM_V_at)$(determine_release_type); \
414 case $$release_type in \
415 [Mm]ajor\ release|[Mm]inor\ release|[Mm]icro\ release);; \
416 *) echo "Cannot upload manuals from a \"$$release_type\"" >&2; \
419 $(AM_V_at)test -f $(web_manual_dir)/$(PACKAGE).html || { \
420 echo 'You have to run "$(MAKE) web-manuals" before' \
421 'invoking "$(MAKE) $@"' >&2; \
427 && $(CVS) -z3 -d :ext:$(CVS_USER)@$(WEBCVS_ROOT)/$(PACKAGE) \
429 @# According to the rsync manpage, "a trailing slash on the
430 @# source [...] avoids creating an additional directory
431 @# level at the destination". So the trailing '/' after
432 @# '$(web_manual_dir)' below is intended.
433 $(AM_V_at)$(RSYNC) -avP $(web_manual_dir)/ $t/$(PACKAGE)/manual
435 && cd $t/$(PACKAGE)/manual \
436 && new_files=`$(CVSU) --types='?'` \
437 && new_files=`echo "$$new_files" | sed s/^..//` \
438 && { test -z "$$new_files" || $(CVS) add -ko $$new_files; } \
439 && $(CVS) ci -m $(VERSION)
441 .PHONY: web-manual-update
444 $(AM_V_at)rm -rf $(web_manual_dir)
445 .PHONY: clean-web-manual
446 clean-local: clean-web-manual
448 EXTRA_DIST += lib/gendocs.sh lib/gendocs_template
450 # ------------------------------------------------ #
451 # Update copyright years of all committed files. #
452 # ------------------------------------------------ #
454 EXTRA_DIST += lib/update-copyright
456 update_copyright_env = \
457 UPDATE_COPYRIGHT_FORCE=1 \
458 UPDATE_COPYRIGHT_USE_INTERVALS=2
460 # In addition to the several README files, these as well are
461 # not expected to have a copyright notice.
462 files_without_copyright = \
474 # This script is in the public domain.
475 files_without_copyright += lib/mkinstalldirs
477 # This script has an MIT-style license
478 files_without_copyright += lib/install-sh
480 # The UPDATE_COPYRIGHT_YEAR environment variable is honoured by the
481 # 'lib/update-copyright' script.
482 .PHONY: update-copyright
485 if test -n "$$UPDATE_COPYRIGHT_YEAR"; then \
486 current_year=$$UPDATE_COPYRIGHT_YEAR; \
488 current_year=`date +%Y` && test -n "$$current_year" \
489 || { echo "$@: cannot get current year" >&2; exit 1; }; \
491 sed -i "/^RELEASE_YEAR=/s/=.*$$/=$$current_year/" \
492 bootstrap.sh configure.ac; \
494 for url in $(FETCHFILES); do echo "$$url"; done \
495 | sed -e 's!^.*/!!' -e 's!^.*=!!' -e 's!^!lib/!' \
496 && for f in $(files_without_copyright); do echo $$f; done \
497 ) | sed -e '$$!s,$$,|,' | tr -d '\012\015'`; \
499 | grep -Ev '(^|/)README$$' \
500 | grep -Ev '^PLANS(/|$$)' \
501 | grep -Ev "^($$excluded_re)$$" \
502 | $(update_copyright_env) xargs $(srcdir)/lib/$@
504 # -------------------------------------------------------------- #
505 # Run the testsuite with the least supported autoconf version. #
506 # -------------------------------------------------------------- #
508 gnu-ftp = http://ftp.gnu.org/gnu
510 # Various shorthands: version, name, package name, tarball name,
511 # tarball location, installation directory.
512 ac-v = $(required_autoconf_version)
514 ac-p = $(ac-n)-$(ac-v)
515 ac-t = $(ac-p).tar.gz
516 ac-l = maintainer/$(ac-t)
517 ac-d = maintainer/$(ac-p)
519 fetch-minimal-autoconf: o = $(ac-l)
520 fetch-minimal-autoconf:
521 $(AM_V_at)$(MKDIR_P) $(dir $o)
522 $(AM_V_at)rm -f $o $o-t
523 $(AM_V_GEN)$(WGET) -O $o-t $(gnu-ftp)/$(ac-n)/$(ac-t)
524 $(AM_V_at)chmod a-w $o-t && mv -f $o-t $o && ls -l $o
525 .PHONY: fetch-minimal-autoconf
527 build-minimal-autoconf:
529 test -f $(ac-l) || { \
530 echo "$@: tarball $(ac-l) seems missing." >&2; \
531 echo "$@: have you run '$(MAKE) fetch-minimal-autoconf'?" >&2; \
535 && $(PERL) $(srcdir)/t/ax/deltree.pl $(ac-d) \
536 && $(MKDIR_P) $(ac-d) \
538 && tar xzf '$(CURDIR)/$(ac-l)' \
542 && env CONFIG_SHELL='$(SHELL)' $(SHELL) ../src/configure \
543 --prefix='$(CURDIR)/$(ac-d)' CONFIG_SHELL='$(SHELL)' \
545 $(AM_V_at)echo ' ======' && $(ac-d)/bin/autoconf --version
546 .PHONY: build-minimal-autoconf
548 check-minimal-autoconf:
549 $(AM_V_at)p='$(ac-d)/bin/autoconf'; \
550 if test ! -f "$$p" || test ! -x "$$p"; then \
551 echo "$@: program '$$p' seems missing." >&2; \
552 echo "$@: have you run '$(MAKE) build-minimal-autoconf'?" >&2; \
556 && PATH='$(CURDIR)/$(ac-d)/bin$(PATH_SEPARATOR)'$$PATH \
558 && AUTOCONF=autoconf \
559 && AUTOHEADER=autoheader \
560 && AUTORECONF=autoreconf \
561 && AUTOM4TE=autom4te \
562 && AUTOUPDATE=autoupdate \
563 && export AUTOCONF AUTOHEADER AUTORECONF AUTOM4TE AUTOUPDATE \
564 && echo === check autoconf version '(must be = $(ac-v))' \
565 && autoconf --version \
566 && autoconf --version | sed -e 's/^/ /; s/$$/ /' -e 1q \
567 | $(FGREP) '$(ac-v)' >/dev/null \
568 && echo === configure \
569 && ./configure $(shell ./config.status --config) \
570 && echo === build and test \
572 .PHONY: check-minimal-autoconf
575 # --------------------------------------------------------------- #
576 # Testing on real-world packages can help us avoid regressions. #
577 # --------------------------------------------------------------- #
580 # NOTE (from Stefano Lattarini):
582 # This section is mostly hacky and ad-hoc, but works for me and
583 # on my system. And while far from clean, it should help catching
584 # real regressions on real world packages, which is important.
585 # Ideas about how to improve this and make it more generic, portable,
586 # clean, etc., are welcome.
589 # Tiny sample package.
590 FEW_PACKAGES += hello
591 # Smallish package using recursive make setup.
593 # Medium-size package using non-recursive make setup.
594 FEW_PACKAGES += coreutils
605 pkg-targets = check dist
607 # Note: "ttp" stays for "Third Party Package".
609 ttp-check ttp-check-all: do-clone = $(GIT) clone --verbose
610 ttp-check: ttp-packages = $(FEW_PACKAGES)
611 ttp-check-all: ttp-packages = $(ALL_PACKAGES)
613 # Note: some packages depend on pkg-config, and its provided macros.
614 ttp-check ttp-check-all: t/pkg-config-macros.log
616 $(setup_autotools_paths); \
620 echo "*** $@: WARNING: $$@" >&2; \
621 echo "*** $@: WARNING: some packages might fail to bootstrap" >&2; \
624 . t/pkg-config-macros.dir/get.sh || exit 1; \
625 mkdir $@.d && cd $@.d || exit 1; \
626 for p in $(ttp-packages); do \
628 echo ======== BEGIN TTP $$p =========; \
631 $(do-clone) git://$(git-sv-host)/$$p.git || exit 1; \
635 && if test -f bootstrap; then \
636 ./bootstrap --no-git; \
641 && if test $$p = make; then \
644 && for t in $(pkg-targets); do \
645 $(MAKE) $$t WERROR_CFLAGS= || exit 1; \
650 echo ======== END TTP $$p =========; \
657 # Alias for lazy typists.
659 ttp-all: ttp-check-all
661 .PHONY: ttp ttp-check ttp-all ttp-check-all