diff options
Diffstat (limited to 'maintainer')
-rwxr-xr-x | maintainer/am-ft | 125 | ||||
-rwxr-xr-x | maintainer/am-xft | 18 | ||||
-rw-r--r-- | maintainer/maint.mk | 569 | ||||
-rwxr-xr-x | maintainer/rename-tests | 67 | ||||
-rw-r--r-- | maintainer/syntax-checks.mk | 553 |
5 files changed, 1332 insertions, 0 deletions
diff --git a/maintainer/am-ft b/maintainer/am-ft new file mode 100755 index 000000000..1d227906e --- /dev/null +++ b/maintainer/am-ft @@ -0,0 +1,125 @@ +#!/usr/bin/env bash +# Remote testing of Automake tarballs made easy. +# This script requires Bash 4.x or later. + +# Copyright (C) 2013 Free Software Foundation, Inc. + +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# TODO: some documentation would be nice ... + +set -u +me=${0##*/} + +fatal () { echo "$me: $*" >&2; exit 1; } + +cmd=' + test_script=$HOME/.am-test/run + if test -f "$test_script" && test -x "$test_script"; then + "$test_script" "$@" + else + nice -n19 ./configure && nice -n19 make -j10 check + fi +' + +remote= +interactive=1 +while test $# -gt 0; do + case $1 in + -b|--batch) interactive=0;; + -c|--command) cmd=${2-}; shift;; + -*) fatal "'$1': invalid option";; + *) remote=$1; shift; break;; + esac + shift +done +[[ -n $remote ]] || fatal "no remote given" + +if ((interactive)); then + do_on_error='{ + AM_TESTSUITE_FAILED=yes + export AM_TESTSUITE_FAILED + # We should not modify the environment with which the failed + # tests have run, hence do not read ".profile", ".bashrc", and + # company. + exec bash --noprofile --norc -i + }' +else + do_on_error='exit $?' +fi + +tarball=$(echo automake*.tar.xz) + +case $tarball in + *' '*) fatal "too many automake tarballs: $tarball";; +esac + +test -f $tarball || fatal "no automake tarball found" + +distdir=${tarball%%.tar.xz} + +env='PATH=$HOME/bin:$PATH' +if test -t 1; then + env+=" TERM='$TERM' AM_COLOR_TESTS=always" +fi + +# This is tempting: +# $ ssh "command" arg-1 ... arg-2 +# but doesn't work as expected. So we need the following hack +# to propagate the command line arguments to the remote shell. +quoted_args=-- +while (($# > 0)); do + case $1 in + *\'*) quoted_args+=" "$(printf '%s\n' "$1" | sed "s/'/'\\''/g");; + *) quoted_args+=" '$1'";; + esac + shift +done + +set -e +set -x + +scp $tarball $remote:tmp/ + +# Multiple '-t' to force tty allocation. +ssh -t -t $remote " + set -x; set -e; set -u; + set $quoted_args + cd tmp + if test -e $distdir; then + # Use 'perl', not only 'rm -rf', to correctly handle read-only + # files or directory. Fall back to 'rm' if something goes awry. + perl -e 'use File::Path qw/rmtree/; rmtree(\"$distdir\")' \ + || rm -rf $distdir || exit 1 + test ! -e $distdir + fi + xz -dc $tarball | tar xf - + cd $distdir + "' + am_extra_acdir=$HOME/.am-test/extra-aclocal + am_extra_bindir=$HOME/.am-test/extra-bin + am_extra_setup=$HOME/.am-test/extra-setup.sh + if test -d "$am_extra_acdir"; then + export ACLOCAL_PATH=$am_extra_acdir${ACLOCAL_PATH+":$ACLOCAL_PATH"} + fi + if test -d "$am_extra_bindir"; then + export PATH=$am_extra_bindir:$PATH + fi + '" + export $env + if test -f \"\$am_extra_setup\"; then + . \"\$am_extra_setup\" + fi + ($cmd) || $do_on_error +" diff --git a/maintainer/am-xft b/maintainer/am-xft new file mode 100755 index 000000000..d7fee4cbb --- /dev/null +++ b/maintainer/am-xft @@ -0,0 +1,18 @@ +#!/bin/sh +# Copyright (C) 2013 Free Software Foundation, Inc. + +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +MAKE=${MAKE-make} GIT=${GIT-git} +$GIT clean -fdx && $MAKE bootstrap && $MAKE dist && exec am-ft "$@" diff --git a/maintainer/maint.mk b/maintainer/maint.mk new file mode 100644 index 000000000..ac29a72da --- /dev/null +++ b/maintainer/maint.mk @@ -0,0 +1,569 @@ +# Maintainer makefile rules for Automake. +# +# Copyright (C) 1995-2013 Free Software Foundation, Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# Avoid CDPATH issues. +unexport CDPATH + +# --------------------------------------------------------- # +# Automatic generation of the ChangeLog from git history. # +# --------------------------------------------------------- # + +gitlog_to_changelog_command = $(PERL) $(srcdir)/lib/gitlog-to-changelog +gitlog_to_changelog_fixes = $(srcdir)/.git-log-fix +gitlog_to_changelog_options = --amend=$(gitlog_to_changelog_fixes) \ + --since='2011-12-28 00:00:00' \ + --no-cluster --format '%s%n%n%b' + +EXTRA_DIST += lib/gitlog-to-changelog +EXTRA_DIST += $(gitlog_to_changelog_fixes) + +# When executed from a git checkout, generate the ChangeLog from the git +# history. When executed from an extracted distribution tarball, just +# copy the distributed ChangeLog in the build directory (and if this +# fails, or if no distributed ChangeLog file is present, complain and +# give an error). +# +# The ChangeLog should be regenerated unconditionally when working from +# checked-out sources; otherwise, if we're working from a distribution +# tarball, we expect the ChangeLog to be distributed, so check that it +# is indeed present in the source directory. +ChangeLog: + $(AM_V_GEN)set -e; set -u; \ + if test -d $(srcdir)/.git; then \ + rm -f $@-t \ + && $(gitlog_to_changelog_command) \ + $(gitlog_to_changelog_options) >$@-t \ + && chmod a-w $@-t \ + && mv -f $@-t $@ \ + || exit 1; \ + elif test ! -f $(srcdir)/$@; then \ + echo "Source tree is not a git checkout, and no pre-existent" \ + "$@ file has been found there" >&2; \ + exit 1; \ + fi +.PHONY: ChangeLog + + +# --------------------------- # +# Perl coverage statistics. # +# --------------------------- # + +PERL_COVERAGE_DB = $(abs_top_builddir)/cover_db +PERL_COVERAGE_FLAGS = -MDevel::Cover=-db,$(PERL_COVERAGE_DB),-silent,on,-summary,off +PERL_COVER = cover + +check-coverage-run recheck-coverage-run: %-coverage-run: all + $(MKDIR_P) $(PERL_COVERAGE_DB) + PERL5OPT="$$PERL5OPT $(PERL_COVERAGE_FLAGS)"; export PERL5OPT; \ + WANT_NO_THREADS=yes; export WANT_NO_THREADS; unset AUTOMAKE_JOBS; \ + $(MAKE) $* + +check-coverage-report: + @if test ! -d "$(PERL_COVERAGE_DB)"; then \ + echo "No coverage database found in '$(PERL_COVERAGE_DB)'." >&2; \ + echo "Please run \"make check-coverage\" first" >&2; \ + exit 1; \ + fi + $(PERL_COVER) $(PERL_COVER_FLAGS) "$(PERL_COVERAGE_DB)" + +# We don't use direct dependencies here because we'd like to be able +# to invoke the report even after interrupted check-coverage. +check-coverage: check-coverage-run + $(MAKE) check-coverage-report + +recheck-coverage: recheck-coverage-run + $(MAKE) check-coverage-report + +clean-coverage: + rm -rf "$(PERL_COVERAGE_DB)" +clean-local: clean-coverage + +.PHONY: check-coverage recheck-coverage check-coverage-run \ + recheck-coverage-run check-coverage-report clean-coverage + + +# ---------------------------------------------------- # +# Tagging and/or uploading stable and beta releases. # +# ---------------------------------------------------- # + +GIT = git + +EXTRA_DIST += lib/gnupload + +base_version_rx = ^[1-9][0-9]*\.[0-9][0-9]* +stable_major_version_rx = $(base_version_rx)$$ +stable_minor_version_rx = $(base_version_rx)\.[0-9][0-9]*$$ +beta_version_rx = $(base_version_rx)(\.[0-9][0-9]*)?[bdfhjlnprtvxz]$$ +match_version = echo "$(VERSION)" | $(EGREP) >/dev/null + +# Check that we don't have uncommitted or unstaged changes. +# TODO: Maybe the git suite already offers a shortcut to verify if the +# TODO: working directory is "clean" or not? If yes, use that instead +# TODO: of duplicating the logic here. +git_must_have_clean_workdir = \ + $(GIT) rev-parse --verify HEAD >/dev/null \ + && $(GIT) update-index -q --refresh \ + && $(GIT) diff-files --quiet \ + && $(GIT) diff-index --quiet --cached HEAD \ + || { echo "$@: you have uncommitted or unstaged changes" >&2; exit 1; } + +determine_release_type = \ + if $(match_version) '$(stable_major_version_rx)'; then \ + release_type='Major release'; \ + announcement_type='major release'; \ + dest=ftp; \ + elif $(match_version) '$(stable_minor_version_rx)'; then \ + release_type='Minor release'; \ + announcement_type='maintenance release'; \ + dest=ftp; \ + elif $(match_version) '$(beta_version_rx)'; then \ + release_type='Beta release'; \ + announcement_type='test release'; \ + dest=alpha; \ + else \ + echo "$@: invalid version '$(VERSION)' for a release" >&2; \ + exit 1; \ + fi + +# Help the debugging of $(determine_release_type) and related code. +print-release-type: + @$(determine_release_type); \ + echo "$$release_type $(VERSION);" \ + "it will be announced as a $$announcement_type" + +git-tag-release: maintainer-check + @set -e -u; \ + case '$(AM_TAG_DRYRUN)' in \ + ""|[nN]|[nN]o|NO) run="";; \ + *) run="echo Running:";; \ + esac; \ + $(determine_release_type); \ + $(git_must_have_clean_workdir); \ + $$run $(GIT) tag -s "v$(VERSION)" -m "$$release_type $(VERSION)" + +git-upload-release: + @# Check this is a version we can cut a release (either test + @# or stable) from. + @$(determine_release_type) + @# The repository must be clean. + @$(git_must_have_clean_workdir) + @# Check that we are releasing from a valid tag. + @tag=`$(GIT) describe` \ + && case $$tag in "v$(VERSION)") true;; *) false;; esac \ + || { echo "$@: you can only create a release from a tagged" \ + "version" >&2; \ + exit 1; } + @# Build the distribution tarball(s). + $(MAKE) dist + @# Upload it to the correct FTP repository. + @$(determine_release_type) \ + && dest=$$dest.gnu.org:automake \ + && echo "Will upload to $$dest: $(DIST_ARCHIVES)" \ + && $(srcdir)/lib/gnupload $(GNUPLOADFLAGS) --to $$dest \ + $(DIST_ARCHIVES) + +.PHONY: print-release-type git-upload-release git-tag-release + + +# ------------------------------------------------------------------ # +# Explore differences of autogenerated files in different commits. # +# ------------------------------------------------------------------ # + +# Visually comparing differences between the Makefile.in files in +# automake's own build system as generated in two different branches +# might help to catch bugs and blunders. This has already happened a +# few times in the past, when we used to version-control Makefile.in. +autodiffs: + @set -u; \ + NEW_COMMIT=$${NEW_COMMIT-"HEAD"}; \ + OLD_COMMIT=$${OLD_COMMIT-"HEAD~1"}; \ + am_gitdir='$(abs_top_srcdir)/.git'; \ + get_autofiles_from_rev () \ + { \ + rev=$$1 dir=$$2 \ + && echo "$@: will get files from revision $$rev" \ + && $(GIT) clone -q --depth 1 "$$am_gitdir" tmp \ + && cd tmp \ + && $(GIT) checkout -q "$$rev" \ + && echo "$@: bootstrapping $$rev" \ + && $(SHELL) ./bootstrap.sh \ + && echo "$@: copying files from $$rev" \ + && makefile_ins=`find . -name Makefile.in` \ + && (tar cf - configure aclocal.m4 $$makefile_ins) | \ + (cd .. && cd "$$dir" && tar xf -) \ + && cd .. \ + && rm -rf tmp; \ + }; \ + outdir=$@.dir \ + && : Before proceeding, ensure the specified revisions truly exist. \ + && $(GIT) --git-dir="$$am_gitdir" describe $$OLD_COMMIT >/dev/null \ + && $(GIT) --git-dir="$$am_gitdir" describe $$NEW_COMMIT >/dev/null \ + && rm -rf $$outdir \ + && mkdir $$outdir \ + && cd $$outdir \ + && mkdir new old \ + && get_autofiles_from_rev $$OLD_COMMIT old \ + && get_autofiles_from_rev $$NEW_COMMIT new \ + && exit 0 + +# With lots of eye candy; we like our developers pampered and spoiled :-) +compare-autodiffs: autodiffs + @set -u; \ + : $${COLORDIFF=colordiff} $${DIFF=diff}; \ + dir=autodiffs.dir; \ + if test ! -d "$$dir"; then \ + echo "$@: $$dir: Not a directory" >&2; \ + exit 1; \ + fi; \ + mydiff=false mypager=false; \ + if test -t 1; then \ + if ($$COLORDIFF -r . .) </dev/null >/dev/null 2>&1; then \ + mydiff=$$COLORDIFF; \ + mypager="less -R"; \ + else \ + mypager=less; \ + fi; \ + else \ + mypager=cat; \ + fi; \ + if test "$$mydiff" = false; then \ + if ($$DIFF -r -u . .); then \ + mydiff=$$DIFF; \ + else \ + echo "$@: no good-enough diff program specified" >&2; \ + exit 1; \ + fi; \ + fi; \ + st=0; $$mydiff -r -u $$dir/old $$dir/new | $$mypager || st=$$?; \ + rm -rf $$dir; \ + exit $$st +.PHONY: autodiffs compare-autodiffs + +# ---------------------------------------------- # +# Help writing the announcement for a release. # +# ---------------------------------------------- # + +PACKAGE_MAILINGLIST = automake@gnu.org + +announcement: NEWS + $(AM_V_GEN): \ + && rm -f $@ $@-t \ + && $(determine_release_type) \ + && ftp_base="ftp://$$dest.gnu.org/gnu/$(PACKAGE)" \ + && X () { printf '%s\n' "$$*" >> $@-t; } \ + && X "We are pleased to announce the $(PACKAGE_NAME) $(VERSION)" \ + "$$announcement_type." \ + && X \ + && X "**TODO** Brief description of the release here." \ + && X \ + && X "**TODO** This description can span multiple paragraphs." \ + && X \ + && X "See below for the detailed list of changes since the" \ + && X "previous version, as summarized by the NEWS file." \ + && X \ + && X "Download here:" \ + && X \ + && X " $$ftp_base/$(PACKAGE)-$(VERSION).tar.gz" \ + && X " $$ftp_base/$(PACKAGE)-$(VERSION).tar.xz" \ + && X \ + && X "Please report bugs and problems to" \ + "<$(PACKAGE_BUGREPORT)>," \ + && X "and send general comments and feedback to" \ + "<$(PACKAGE_MAILINGLIST)>." \ + && X \ + && X "Thanks to everyone who has reported problems, contributed" \ + && X "patches, and helped testing Automake!" \ + && X \ + && X "-*-*-*-" \ + && X \ + && $(AWK) '\ + ($$0 == "New in $(VERSION):") { wait_for_end=1; } \ + (/^~~~/ && wait_for_end) { exit(0) } \ + { print } \ + ' <$(srcdir)/NEWS >> $@-t \ + && mv -f $@-t $@ +.PHONY: announcement +CLEANFILES += announcement + +# --------------------------------------------------------------------- # +# Synchronize third-party files that are committed in our repository. # +# --------------------------------------------------------------------- # + +# Program to use to fetch files. +WGET = wget + +# Git repositories on Savannah. +git-sv-host = git.savannah.gnu.org + +# Some repositories we sync files from. +SV_CVS = 'http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/' +SV_GIT_CF = 'http://$(git-sv-host)/gitweb/?p=config.git;a=blob_plain;hb=HEAD;f=' +SV_GIT_AC = 'http://$(git-sv-host)/gitweb/?p=autoconf.git;a=blob_plain;hb=HEAD;f=' +SV_GIT_GL = 'http://$(git-sv-host)/gitweb/?p=gnulib.git;a=blob_plain;hb=HEAD;f=' + +# Files that we fetch and which we compare against. +# Note that the 'lib/COPYING' file must still be synced by hand. +FETCHFILES = \ + $(SV_GIT_CF)config.guess \ + $(SV_GIT_CF)config.sub \ + $(SV_CVS)texinfo/texinfo/doc/texinfo.tex \ + $(SV_CVS)texinfo/texinfo/util/gendocs.sh \ + $(SV_CVS)texinfo/texinfo/util/gendocs_template \ + $(SV_GIT_GL)build-aux/gitlog-to-changelog \ + $(SV_GIT_GL)build-aux/gnupload \ + $(SV_GIT_GL)build-aux/update-copyright \ + $(SV_GIT_GL)doc/INSTALL + +# Fetch the latest versions of few scripts and files we care about. +# A retrieval failure or a copying failure usually mean serious problems, +# so we'll just bail out if 'wget' or 'cp' fail. +fetch: + $(AM_V_at)rm -rf Fetchdir + $(AM_V_at)mkdir Fetchdir + $(AM_V_GEN)set -e; \ + if $(AM_V_P); then wget_opts=; else wget_opts=-nv; fi; \ + for url in $(FETCHFILES); do \ + file=`printf '%s\n' "$$url" | sed 's|^.*/||; s|^.*=||'`; \ + $(WGET) $$wget_opts "$$url" -O Fetchdir/$$file || exit 1; \ + if cmp Fetchdir/$$file $(srcdir)/lib/$$file >/dev/null; then \ + : Nothing to do; \ + else \ + echo "$@: updating file $$file"; \ + cp Fetchdir/$$file $(srcdir)/lib/$$file || exit 1; \ + fi; \ + done + $(AM_V_at)rm -rf Fetchdir +.PHONY: fetch + +# ---------------------------------------------------------------------- # +# Generate and upload manuals in several formats, for the GNU website. # +# ---------------------------------------------------------------------- # + +web_manual_dir = doc/web-manual + +RSYNC = rsync +CVS = cvs +CVSU = cvsu +CVS_USER = $${USER} +WEBCVS_ROOT = cvs.savannah.gnu.org:/web +CVS_RSH = ssh +export CVS_RSH + +.PHONY: web-manual web-manual-update +web-manual web-manual-update: t = $@.dir + +# Build manual in several formats. Note to the recipe: +# 1. The symlinking of automake.texi into the temporary directory is +# required to pacify extra checks from gendocs.sh. +# 2. The redirection to /dev/null before the invocation of gendocs.sh +# is done to better respect silent rules. +web-manual: + $(AM_V_at)rm -rf $(web_manual_dir) $t + $(AM_V_at)mkdir $t + $(AM_V_at)$(LN_S) '$(abs_srcdir)/doc/$(PACKAGE).texi' '$t/' + $(AM_V_GEN)cd $t \ + && GENDOCS_TEMPLATE_DIR='$(abs_srcdir)/lib' \ + && export GENDOCS_TEMPLATE_DIR \ + && if $(AM_V_P); then :; else exec >/dev/null 2>&1; fi \ + && $(SHELL) '$(abs_srcdir)/lib/gendocs.sh' \ + -I '$(abs_srcdir)/doc' --email $(PACKAGE_BUGREPORT) \ + $(PACKAGE) '$(PACKAGE_NAME)' + $(AM_V_at)mkdir $(web_manual_dir) + $(AM_V_at)mv -f $t/manual/* $(web_manual_dir) + $(AM_V_at)rm -rf $t + @! $(AM_V_P) || ls -l $(web_manual_dir) + +# Upload manual to www.gnu.org, using CVS (sigh!) +web-manual-update: + $(AM_V_at)$(determine_release_type); \ + case $$release_type in \ + [Mm]ajor\ release|[Mm]inor\ release);; \ + *) echo "Cannot upload manuals from a \"$$release_type\"" >&2; \ + exit 1;; \ + esac + $(AM_V_at)test -f $(web_manual_dir)/$(PACKAGE).html || { \ + echo 'You have to run "$(MAKE) web-manuals" before' \ + 'invoking "$(MAKE) $@"' >&2; \ + exit 1; \ + } + $(AM_V_at)rm -rf $t + $(AM_V_at)mkdir $t + $(AM_V_at)cd $t \ + && $(CVS) -z3 -d :ext:$(CVS_USER)@$(WEBCVS_ROOT)/$(PACKAGE) \ + co $(PACKAGE) + @# According to the rsync manpage, "a trailing slash on the + @# source [...] avoids creating an additional directory + @# level at the destination". So the trailing '/' after + @# '$(web_manual_dir)' below is intended. + $(AM_V_at)$(RSYNC) -avP $(web_manual_dir)/ $t/$(PACKAGE)/manual + $(AM_V_GEN): \ + && cd $t/$(PACKAGE)/manual \ + && new_files=`$(CVSU) --types='?'` \ + && new_files=`echo "$$new_files" | sed s/^..//` \ + && { test -z "$$new_files" || $(CVS) add -ko $$new_files; } \ + && $(CVS) ci -m $(VERSION) + $(AM_V_at)rm -rf $t +.PHONY: web-manual-update + +clean-web-manual: + $(AM_V_at)rm -rf $(web_manual_dir) +.PHONY: clean-web-manual +clean-local: clean-web-manual + +EXTRA_DIST += lib/gendocs.sh lib/gendocs_template + +# ------------------------------------------------ # +# Update copyright years of all committed files. # +# ------------------------------------------------ # + +EXTRA_DIST += lib/update-copyright + +update_copyright_env = \ + UPDATE_COPYRIGHT_FORCE=1 \ + UPDATE_COPYRIGHT_USE_INTERVALS=2 + +# In addition to the several README files, these as well are +# not expected to have a copyright notice. +files_without_copyright = \ + .autom4te.cfg \ + .git-log-fix \ + .gitattributes \ + .gitignore \ + INSTALL \ + COPYING \ + AUTHORS \ + THANKS \ + lib/INSTALL \ + lib/COPYING + +# This script is in the public domain. +files_without_copyright += lib/mkinstalldirs + +# This script has an MIT-style license +files_without_copyright += lib/install-sh + +# The UPDATE_COPYRIGHT_YEAR environment variable is honoured by the +# 'lib/update-copyright' script. +.PHONY: update-copyright +update-copyright: + $(AM_V_GEN)set -e; \ + if test -n "$$UPDATE_COPYRIGHT_YEAR"; then \ + current_year=$$UPDATE_COPYRIGHT_YEAR; \ + else \ + current_year=`date +%Y` && test -n "$$current_year" \ + || { echo "$@: cannot get current year" >&2; exit 1; }; \ + fi; \ + sed -i "/^RELEASE_YEAR=/s/=.*$$/=$$current_year/" \ + bootstrap.sh configure.ac; \ + excluded_re=`( \ + for url in $(FETCHFILES); do echo "$$url"; done \ + | sed -e 's!^.*/!!' -e 's!^.*=!!' -e 's!^!lib/!' \ + && for f in $(files_without_copyright); do echo $$f; done \ + ) | sed -e '$$!s,$$,|,' | tr -d '\012\015'`; \ + $(GIT) ls-files \ + | grep -Ev '(^|/)README$$' \ + | grep -Ev '^PLANS(/|$$)' \ + | grep -Ev "^($$excluded_re)$$" \ + | $(update_copyright_env) xargs $(srcdir)/lib/$@ + +# --------------------------------------------------------------- # +# Testing on real-world packages can help us avoid regressions. # +# --------------------------------------------------------------- # + +# +# NOTE (from Stefano Lattarini): +# +# This section is mostly hacky and ad-hoc, but works for me and +# on my system. And while far from clean, it should help catching +# real regressions on real world packages, which is important. +# Ideas about how to improve this and make it more generic, portable, +# clean, etc., are welcome. +# + +# Tiny sample package. +FEW_PACKAGES += hello +# Smallish package using recursive make setup. +FEW_PACKAGES += make +# Medium-size package using non-recursive make setup. +FEW_PACKAGES += coreutils + +ALL_PACKAGES = \ + $(FEW_PACKAGES) \ + autoconf \ + bison \ + grep \ + tar \ + diffutils \ + smalltalk + +pkg-targets = check dist + +# Note: "ttp" stays for "Third Party Package". + +ttp-check ttp-check-all: do-clone = $(GIT) clone --verbose +ttp-check: ttp-packages = $(FEW_PACKAGES) +ttp-check-all: ttp-packages = $(ALL_PACKAGES) + +# Note: some packages depend on pkg-config, and its provided macros. +ttp-check ttp-check-all: t/pkg-config-macros.log + @set -e; \ + $(setup_autotools_paths); \ + skip_all_ () \ + { \ + echo "***" >&2; \ + echo "*** $@: WARNING: $$@" >&2; \ + echo "*** $@: WARNING: some packages might fail to bootstrap" >&2; \ + echo "***" >&2; \ + }; \ + . t/pkg-config-macros.dir/get.sh || exit 1; \ + mkdir $@.d && cd $@.d || exit 1; \ + for p in $(ttp-packages); do \ + echo; \ + echo ======== BEGIN TTP $$p =========; \ + echo; \ + set -x; \ + $(do-clone) git://$(git-sv-host)/$$p.git || exit 1; \ + ( \ + cd $$p \ + && ls -l \ + && if test -f bootstrap; then \ + ./bootstrap --no-git; \ + else \ + $$AUTORECONF -fvi; \ + fi \ + && ./configure \ + && if test $$p = make; then \ + $(MAKE) update; \ + else :; fi \ + && for t in $(pkg-targets); do \ + $(MAKE) $$t WERROR_CFLAGS= || exit 1; \ + done \ + ) || exit 1; \ + set +x; \ + echo; \ + echo ======== END TTP $$p =========; \ + echo; \ + done +ifndef keep-ttp-dir + rm -rf $@.d +endif + +# Alias for lazy typists. +ttp: ttp-check +ttp-all: ttp-check-all + +.PHONY: ttp ttp-check ttp-all ttp-check-all diff --git a/maintainer/rename-tests b/maintainer/rename-tests new file mode 100755 index 000000000..28963fa37 --- /dev/null +++ b/maintainer/rename-tests @@ -0,0 +1,67 @@ +#!/usr/bin/env bash +# Convenience script to rename test cases in Automake. + +# Copyright (C) 2013 Free Software Foundation, Inc. + +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +set -e -u + +me=${0##*/} +fatal () { echo "$me: $*" >&2; exit 1; } + +case $# in + 0) input=$(cat);; + 1) input=$(cat -- "$1");; + *) fatal "too many arguments";; +esac + +AWK=${AWK-awk} +SED=${SED-sed} + +[[ -f bin/automake.in && -d lib/Automake ]] \ + || fatal "can only be run from the top-level of the Automake source tree" + +$SED --version 2>&1 | grep GNU >/dev/null 2>&1 \ + || fatal "GNU sed is required by this script" + +# Validate and cleanup input. +input=$( + $AWK -v me="$me" " + /^#/ { next; } + (NF == 0) { next; } + (NF != 2) { print me \": wrong number of fields at line \" NR; + exit(1); } + { printf (\"t/%s t/%s\\n\", \$1, \$2); } + " <<<"$input") + +# Prepare git commit message. +exec 5>$me.git-msg +echo "tests: more significant names for some tests" >&5 +echo >&5 +$AWK >&5 <<<"$input" \ + '{ printf ("* %s: Rename...\n* %s: ... like this.\n", $1, $2) }' +exec 5>&- + +# Rename tests. +eval "$($AWK '{ printf ("git mv %s %s\n", $1, $2) }' <<<"$input")" + +# Adjust the list of tests (do this conditionally, since such a +# list is not required nor used in Automake-NG. +if test -f t/list-of-tests.mk; then + $SED -e "$($AWK '{ printf ("s|^%s |%s |\n", $1, $2) }' <<<"$input")" \ + -i t/list-of-tests.mk +fi + +git status diff --git a/maintainer/syntax-checks.mk b/maintainer/syntax-checks.mk new file mode 100644 index 000000000..d29ce3047 --- /dev/null +++ b/maintainer/syntax-checks.mk @@ -0,0 +1,553 @@ +# Maintainer checks for Automake. Requires GNU make. + +# Copyright (C) 2012-2013 Free Software Foundation, Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# We also have to take into account VPATH builds (where some generated +# tests might be in '$(builddir)' rather than in '$(srcdir)'), TAP-based +# tests script (which have a '.tap' extension) and helper scripts used +# by other test cases (which have a '.sh' extension). +xtests := $(shell \ + if test $(srcdir) = .; then \ + dirs=.; \ + else \ + dirs='$(srcdir) .'; \ + fi; \ + for d in $$dirs; do \ + for s in tap sh; do \ + ls $$d/t/ax/*.$$s $$d/t/*.$$s $$d/contrib/t/*.$$s 2>/dev/null; \ + done; \ + done | sort) + +xdefs = \ + $(srcdir)/t/ax/am-test-lib.sh \ + $(srcdir)/t/ax/test-lib.sh \ + $(srcdir)/t/ax/test-defs.in + +ams := $(shell find $(srcdir) -name '*.dir' -prune -o -name '*.am' -print) + +# Some simple checks, and then ordinary check. These are only really +# guaranteed to work on my machine. +syntax_check_rules = \ +$(sc_tests_plain_check_rules) \ +sc_diff_automake \ +sc_diff_aclocal \ +sc_no_brace_variable_expansions \ +sc_rm_minus_f \ +sc_no_for_variable_in_macro \ +sc_mkinstalldirs \ +sc_pre_normal_post_install_uninstall \ +sc_perl_no_undef \ +sc_perl_no_split_regex_space \ +sc_cd_in_backquotes \ +sc_cd_relative_dir \ +sc_perl_at_uscore_in_scalar_context \ +sc_perl_local \ +sc_AMDEP_TRUE_in_automake_in \ +sc_tests_make_without_am_makeflags \ +$(sc_obsolete_requirements_rules) \ +sc_tests_no_source_defs \ +sc_tests_obsolete_variables \ +sc_tests_here_document_format \ +sc_tests_command_subst \ +sc_tests_no_run_make_redirect \ +sc_tests_exit_not_Exit \ +sc_tests_automake_fails \ +sc_tests_required_after_defs \ +sc_tests_overriding_macros_on_cmdline \ +sc_tests_no_make_e \ +sc_tests_plain_sleep \ +sc_tests_ls_t \ +sc_m4_am_plain_egrep_fgrep \ +sc_tests_no_configure_in \ +sc_tests_PATH_SEPARATOR \ +sc_tests_logs_duplicate_prefixes \ +sc_tests_makefile_variable_order \ +sc_perl_at_substs \ +sc_unquoted_DESTDIR \ +sc_tabs_in_texi \ +sc_at_in_texi + +## These check avoids accidental configure substitutions in the source. +## There are exactly 8 lines that should be modified from automake.in to +## automake, and 9 lines that should be modified from aclocal.in to +## aclocal. +automake_diff_no = 8 +aclocal_diff_no = 9 +sc_diff_automake sc_diff_aclocal: in=$($*_in) +sc_diff_automake sc_diff_aclocal: out=$($*_script) +sc_diff_automake sc_diff_aclocal: sc_diff_% : + @set +e; \ + in=$*-in.tmp out=$*-out.tmp diffs=$*-diffs.tmp \ + && sed '/^#!.*[pP]rototypes/d' $(in) > $$in \ + && sed '/^# BEGIN.* PROTO/,/^# END.* PROTO/d' $(out) > $$out \ + && { diff -u $$in $$out > $$diffs; test $$? -eq 1; } \ + && added=`grep -v '^+++ ' $$diffs | grep -c '^+'` \ + && removed=`grep -v '^--- ' $$diffs | grep -c '^-'` \ + && test $$added,$$removed = $($*_diff_no),$($*_diff_no) \ + || { \ + echo "Found unexpected diffs between $(in) and $(out)"; \ + echo "Lines added: $$added" ; \ + echo "Lines removed: $$removed"; \ + cat $$diffs; \ + exit 1; \ + } >&2; \ + rm -f $$in $$out $$diffs + +## Expect no instances of '${...}'. However, $${...} is ok, since that +## is a shell construct, not a Makefile construct. +sc_no_brace_variable_expansions: + @if grep -v '^ *#' $(ams) | grep -F '$${' | grep -F -v '$$$$'; then \ + echo "Found too many uses of '\$${' in the lines above." 1>&2; \ + exit 1; \ + else :; fi + +## Make sure 'rm' is called with '-f'. +sc_rm_minus_f: + @if grep -v '^#' $(ams) $(xtests) \ + | grep -vE '/(rm-f-probe\.sh|spy-rm\.tap|subobj-clean.*-pr10697\.sh):' \ + | grep -E '\<rm ([^-]|\-[^f ]*\>)'; \ + then \ + echo "Suspicious 'rm' invocation." 1>&2; \ + exit 1; \ + else :; fi + +## Never use something like "for file in $(FILES)", this doesn't work +## if FILES is empty or if it contains shell meta characters (e.g. $ is +## commonly used in Java filenames). +sc_no_for_variable_in_macro: + @if grep 'for .* in \$$(' $(ams) | grep -v '/Makefile\.am:'; then \ + echo 'Use "list=$$(mumble); for var in $$$$list".' 1>&2 ; \ + exit 1; \ + else :; fi + +## Make sure all invocations of mkinstalldirs are correct. +sc_mkinstalldirs: + @if grep -n 'mkinstalldirs' $(ams) \ + | grep -F -v '$$(mkinstalldirs)' \ + | grep -v '^\./Makefile.am:[0-9][0-9]*: *lib/mkinstalldirs \\$$'; \ + then \ + echo "Found incorrect use of mkinstalldirs in the lines above" 1>&2; \ + exit 1; \ + else :; fi + +## Make sure all calls to PRE/NORMAL/POST_INSTALL/UNINSTALL +sc_pre_normal_post_install_uninstall: + @if grep -E -n '\((PRE|NORMAL|POST)_(|UN)INSTALL\)' $(ams) | \ + grep -v ':##' | grep -v ': @\$$('; then \ + echo "Found incorrect use of PRE/NORMAL/POST_INSTALL/UNINSTALL in the lines above" 1>&2; \ + exit 1; \ + else :; fi + +## We never want to use "undef", only "delete", but for $/. +sc_perl_no_undef: + @if grep -n -w 'undef ' $(automake_in) | \ + grep -F -v 'undef $$/'; then \ + echo "Found 'undef' in the lines above; use 'delete' instead" 1>&2; \ + exit 1; \ + fi + +## We never want split (/ /,...), only split (' ', ...). +sc_perl_no_split_regex_space: + @if grep -n 'split (/ /' $(automake_in) $(acloca_in); then \ + echo "Found bad split in the lines above." 1>&2; \ + exit 1; \ + fi + +## Look for cd within backquotes +sc_cd_in_backquotes: + @if grep -n '^[^#]*` *cd ' $(automake_in) $(ams); then \ + echo "Consider using \$$(am__cd) in the lines above." 1>&2; \ + exit 1; \ + fi + +## Look for cd to a relative directory (may be influenced by CDPATH). +## Skip some known directories that are OK. +sc_cd_relative_dir: + @if grep -n '^[^#]*cd ' $(automake_in) $(ams) | \ + grep -v 'echo.*cd ' | \ + grep -v 'am__cd =' | \ + grep -v '^[^#]*cd [./]' | \ + grep -v '^[^#]*cd \$$(top_builddir)' | \ + grep -v '^[^#]*cd "\$$\$$am__cwd' | \ + grep -v '^[^#]*cd \$$(abs' | \ + grep -v '^[^#]*cd "\$$(DESTDIR)'; then \ + echo "Consider using \$$(am__cd) in the lines above." 1>&2; \ + exit 1; \ + fi + +## Using @_ in a scalar context is most probably a programming error. +sc_perl_at_uscore_in_scalar_context: + @if grep -Hn '[^%@_A-Za-z0-9][_A-Za-z0-9]*[^) ] *= *@_' \ + $(automake_in) $(aclocal_in); then \ + echo "Using @_ in a scalar context in the lines above." 1>&2; \ + exit 1; \ + fi + +## Allow only few variables to be localized in automake and aclocal. +sc_perl_local: + @if egrep -v '^[ \t]*local \$$[_~]( *=|;)' \ + $(automake_in) $(aclocal_in) | \ + grep '^[ \t]*local [^*]'; then \ + echo "Please avoid 'local'." 1>&2; \ + exit 1; \ + fi + +## Don't let AMDEP_TRUE substitution appear in automake.in. +sc_AMDEP_TRUE_in_automake_in: + @if grep '@AMDEP''_TRUE@' $(automake_in); then \ + echo "Don't put AMDEP_TRUE substitution in automake.in" 1>&2; \ + exit 1; \ + fi + +## Recursive make invocations should always pass $(AM_MAKEFLAGS) +## to $(MAKE), for portability to non-GNU make. +sc_tests_make_without_am_makeflags: + @if grep '^[^#].*(MAKE) ' $(ams) $(automake_in) \ + | grep -Fv '$$(AM_MAKEFLAGS)'; \ + then \ + echo 'Use $$(MAKE) $$(AM_MAKEFLAGS).' 1>&2; \ + exit 1; \ + fi + +## Look out for some obsolete variables. +sc_tests_obsolete_variables: + @vars=" \ + using_tap \ + am_using_tap \ + test_prefer_config_shell \ + original_AUTOMAKE \ + original_ACLOCAL \ + parallel_tests \ + am_parallel_tests \ + "; \ + seen=""; \ + for v in $$vars; do \ + if grep -E "\b$$v\b" $(xtests) $(xdefs); then \ + seen="$$seen $$v"; \ + fi; \ + done; \ + if test -n "$$seen"; then \ + for v in $$seen; do \ + case $$v in \ + parallel_tests|am_parallel_tests) v2=am_serial_tests;; \ + *) v2=am_$$v;; \ + esac; \ + echo "Variable '$$v' is obsolete, use '$$v2' instead." 1>&2; \ + done; \ + exit 1; \ + else :; fi + +## Look out for obsolete requirements specified in the test cases. +sc_obsolete_requirements_rules = sc_no_texi2dvi-o sc_no_makeinfo-html +modern-requirement.texi2dvi-o = texi2dvi +modern-requirement.makeinfo-html = makeinfo + +$(sc_obsolete_requirements_rules): sc_no_% : + @if grep -E 'required=.*\b$*\b' $(xtests); then \ + echo "Requirement '$*' is obsolete and shouldn't" \ + "be used anymore." >&2; \ + echo "You should use '$(modern-requirement.$*)' instead." >&2; \ + exit 1; \ + fi + +## Tests should never call some programs directly, but only through the +## corresponding variable (e.g., '$MAKE', not 'make'). This will allow +## the programs to be overridden at configure time (for less brittleness) +## or by the user at make time (to allow better testsuite coverage). +sc_tests_plain_check_rules = \ + sc_tests_plain_egrep \ + sc_tests_plain_fgrep \ + sc_tests_plain_make \ + sc_tests_plain_perl \ + sc_tests_plain_automake \ + sc_tests_plain_aclocal \ + sc_tests_plain_autoconf \ + sc_tests_plain_autoupdate \ + sc_tests_plain_autom4te \ + sc_tests_plain_autoheader \ + sc_tests_plain_autoreconf + +toupper = $(shell echo $(1) | LC_ALL=C tr '[a-z]' '[A-Z]') + +$(sc_tests_plain_check_rules): sc_tests_plain_% : + @# The leading ':' in the grep below is what is printed by the + @# preceding 'grep -v' after the file name. + @# It works here as a poor man's substitute for beginning-of-line + @# marker. + @if grep -v '^[ ]*#' $(xtests) \ + | $(EGREP) '(:|\bif|\bnot|[;!{\|\(]|&&|\|\|)[ ]*?$*\b'; \ + then \ + echo 'Do not run "$*" in the above tests.' \ + 'Use "$$$(call toupper,$*)" instead.' 1>&2; \ + exit 1; \ + fi + +## Tests should only use END and EOF for here documents +## (so that the next test is effective). +sc_tests_here_document_format: + @if grep '<<' $(xtests) | grep -Ev '\b(END|EOF)\b|\bcout <<'; then \ + echo 'Use here documents with "END" and "EOF" only, for greppability.' 1>&2; \ + exit 1; \ + fi + +## Our test case should use the $(...) POSIX form for command substitution, +## rather than the older `...` form. +## The point of ignoring text on here-documents is that we want to exempt +## Makefile.am rules, configure.ac code and helper shell script created and +## used by out shell scripts, because Autoconf (as of version 2.69) does not +## yet ensure that $CONFIG_SHELL will be set to a proper POSIX shell. +sc_tests_command_subst: + @found=false; \ + scan () { \ + sed -n -e '/^#/d' \ + -e '/<<.*END/,/^END/b' -e '/<<.*EOF/,/^EOF/b' \ + -e 's/\\`/\\{backtick}/' \ + -e "s/[^\\]'\([^']*\`[^']*\)*'/'{quoted-text}'/g" \ + -e '/`/p' $$*; \ + }; \ + for file in $(xtests); do \ + res=`scan $$file`; \ + if test -n "$$res"; then \ + echo "$$file:$$res"; \ + found=true; \ + fi; \ + done; \ + if $$found; then \ + echo 'Use $$(...), not `...`, for command substitutions.' >&2; \ + exit 1; \ + fi + +## Tests should no longer call 'Exit', just 'exit'. That's because we +## now have in place a better workaround to ensure the exit status is +## transported correctly across the exit trap. +sc_tests_exit_not_Exit: + @if grep 'Exit' $(xtests) $(xdefs) | grep -Ev '^[^:]+: *#' | grep .; then \ + echo "Use 'exit', not 'Exit'; it's obsolete now." 1>&2; \ + exit 1; \ + fi + +## Guard against obsolescent uses of ./defs in tests. Now, +## 'test-init.sh' should be used instead. +sc_tests_no_source_defs: + @if grep -E '\. .*defs($$| )' $(xtests); then \ + echo "Source 'test-init.sh', not './defs'." 1>&2; \ + exit 1; \ + fi + +## Invocation of 'run_make' should not have output redirections. +sc_tests_no_run_make_redirect: + @if grep -Pzo '.*(\$$MAKE|\brun_make)\b(.*(\\\n))*.*>.*' $(xtests); \ + then \ + echo 'Do not redirect stdout/stderr in "run_make" or "$$MAKE"' \ + 'invocations,' >&2; \ + echo 'use "run_make {-E|-O|-M}" instead.' >&2; \ + exit 1; \ + fi + +## Use AUTOMAKE_fails when appropriate +sc_tests_automake_fails: + @if grep -v '^#' $(xtests) | grep '\$$AUTOMAKE.*&&.*exit'; then \ + echo 'Use AUTOMAKE_fails + grep to catch automake failures in the above tests.' 1>&2; \ + exit 1; \ + fi + +## Setting 'required' after sourcing 'test-init.sh' is a bug. +sc_tests_required_after_defs: + @for file in $(xtests); do \ + if out=`sed -n '/test-init\.sh/,$${/required=/p;}' $$file`; test -n "$$out"; then \ + echo 'Do not set "required" after sourcing "test-init.sh" in '"$$file: $$out" 1>&2; \ + exit 1; \ + fi; \ + done + +# "make -e" is brittle and unsafe, since it let *all* the environment +# win over the macro definitions in the Makefiles. Since we offer +# AM_MAKEFLAGS to allow the user to portably override macro definitions +# from the command line in a safe way, we should encourage users to use +# it. +sc_tests_no_make_e: + @if grep -E '\$$MAKE\b.* -[a-zA-Z0-9]*e' $(xtests); then \ + echo '"make -e" is brittle, use "run_make" instead.' 1>&2; \ + exit 1; \ + fi + +## Overriding a Makefile macro on the command line is not portable when +## recursive targets are used. Better use an envvar. SHELL is an +## exception, POSIX says it can't come from the environment. V, DESTDIR, +## DISTCHECK_CONFIGURE_FLAGS and DISABLE_HARD_ERRORS are exceptions, too, +## as package authors are urged not to initialize them anywhere. +## Finally, 'exp' is used by some ad-hoc checks, where we ensure it's +## ok to override it from the command line. +sc_tests_overriding_macros_on_cmdline: +# The first s/// tries to account for usages like "$MAKE || st=$?". +# 'DISTCHECK_CONFIGURE_FLAGS' and 'exp' are allowed to contain whitespace in +# their definitions, hence the more complex last three substitutions below. + @if sed -e 's/ || .*//' -e 's/ && .*//' \ + -e 's/ DESTDIR=[^ ]*/ /' -e 's/ SHELL=[^ ]*/ /' \ + -e 's/ V=[^ ]*/ /' -e 's/ DISABLE_HARD_ERRORS=[^ ]*/ /' \ + -e "s/ DISTCHECK_CONFIGURE_FLAGS='[^']*'/ /" \ + -e 's/ DISTCHECK_CONFIGURE_FLAGS="[^"]*"/ /' \ + -e 's/ DISTCHECK_CONFIGURE_FLAGS=[^ ]/ /' \ + -e "s/ exp='[^']*'/ /" \ + -e 's/ exp="[^"]*"/ /' \ + -e 's/ exp=[^ ]/ /' \ + $(filter-out %/am-test-lib.sh,$(xtests)) \ + | grep '\$$MAKE .*='; then \ + echo 'Rewrite "$$MAKE foo=bar" as "run_make foo=bar" in the lines above,'; \ + echo 'it is more portable.'; \ + exit 1; \ + fi >&2 + @if grep 'SHELL=.*\$$MAKE' $(xtests); then \ + echo '$$MAKE ignores the SHELL envvar, use "run_make SHELL=$$SHELL"'; \ + echo 'in the above lines.'; \ + exit 1; \ + fi >&2 + +## Prefer use of our 'is_newest' auxiliary script over the more hacky +## idiom "test $(ls -1t new old | sed 1q) = new", which is both more +## cumbersome and more fragile. +sc_tests_ls_t: + @if LC_ALL=C grep -E '\bls(\s+-[a-zA-Z0-9]+)*\s+-[a-zA-Z0-9]*t' \ + $(xtests); then \ + echo "Use 'is_newest' rather than hacks based on 'ls -t'" 1>&2; \ + exit 1; \ + fi + +## Never use 'sleep 1' to create files with different timestamps. +## Use '$sleep' instead. Some file systems (e.g., Windows) have only +## a 2sec resolution. +sc_tests_plain_sleep: + @if grep -E '\bsleep +[12345]\b' $(xtests); then \ + echo 'Do not use "sleep x" in the above tests. Use "$$sleep" instead.' 1>&2; \ + exit 1; \ + fi + +## fgrep and egrep are not required by POSIX. +sc_m4_am_plain_egrep_fgrep: + @if grep -E '\b[ef]grep\b' $(ams) $(srcdir)/m4/*.m4; then \ + echo 'Do not use egrep or fgrep in the above files,' \ + 'they are not portable.' 1>&2; \ + exit 1; \ + fi + +## Prefer 'configure.ac' over the obsolescent 'configure.in' as the name +## for configure input files in our testsuite. The latter has been +## deprecated for several years (at least since autoconf 2.50). +sc_tests_no_configure_in: + @if grep -E '\bconfigure\\*\.in\b' $(xtests) $(xdefs) \ + | grep -Ev '/backcompat.*\.(sh|tap):' \ + | grep -Ev '/autodist-configure-no-subdir\.sh:' \ + | grep -Ev '/(configure|help)\.sh:' \ + | grep .; \ + then \ + echo "Use 'configure.ac', not 'configure.in', as the name" >&2; \ + echo "for configure input files in the test cases above." >&2; \ + exit 1; \ + fi + +## Rule to ensure that the testsuite has been run before. We don't depend +## on 'check' here, because that would be very wasteful in the common case. +## We could run "make check RECHECK_LOGS=" and avoid toplevel races with +## AM_RECURSIVE_TARGETS. Suggest keeping test directories around for +## greppability of the Makefile.in files. +sc_ensure_testsuite_has_run: + @if test ! -f '$(TEST_SUITE_LOG)'; then \ + echo 'Run "env keep_testdirs=yes make check" before' \ + 'running "make maintainer-check"' >&2; \ + exit 1; \ + fi +.PHONY: sc_ensure_testsuite_has_run + +## Ensure our warning and error messages do not contain duplicate 'warning:' prefixes. +## This test actually depends on the testsuite having been run before. +sc_tests_logs_duplicate_prefixes: sc_ensure_testsuite_has_run + @if grep -E '(warning|error):.*(warning|error):' t/*.log; then \ + echo 'Duplicate warning/error message prefixes seen in above tests.' >&2; \ + exit 1; \ + fi + +## Ensure variables are listed before rules in Makefile.in files we generate. +sc_tests_makefile_variable_order: sc_ensure_testsuite_has_run + @st=0; \ + for file in `find t -name Makefile.in -print`; do \ + latevars=`sed -n \ + -e :x -e 's/#.*//' \ + -e '/\\\\$$/{' -e N -e 'b x' -e '}' \ + -e '# Literal TAB.' \ + -e '1,/^ /d' \ + -e '# Allow @ so we match conditionals.' \ + -e '/^ *[a-zA-Z_@]\{1,\} *=/p' $$file`; \ + if test -n "$$latevars"; then \ + echo "Variables are expanded too late in $$file:" >&2; \ + echo "$$latevars" | sed 's/^/ /' >&2; \ + st=1; \ + fi; \ + done; \ + test $$st -eq 0 || { \ + echo 'Ensure variables are expanded before rules' >&2; \ + exit 1; \ + } + +## Using ':' as a PATH separator is not portable. +sc_tests_PATH_SEPARATOR: + @if grep -E '\bPATH=.*:.*' $(xtests) ; then \ + echo "Use '\$$PATH_SEPARATOR', not ':', in PATH definitions" \ + "above." 1>&2; \ + exit 1; \ + fi + +## Try to make sure all @...@ substitutions are covered by our +## substitution rule. +sc_perl_at_substs: + @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' bin/aclocal | wc -l` -ne 0; then \ + echo "Unresolved @...@ substitution in aclocal" 1>&2; \ + exit 1; \ + fi + @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' bin/automake | wc -l` -ne 0; then \ + echo "Unresolved @...@ substitution in automake" 1>&2; \ + exit 1; \ + fi + +sc_unquoted_DESTDIR: + @if grep -E "[^\'\"]\\\$$\(DESTDIR" $(ams); then \ + echo 'Suspicious unquoted DESTDIR uses.' 1>&2 ; \ + exit 1; \ + fi + +sc_tabs_in_texi: + @if grep ' ' $(srcdir)/doc/automake.texi; then \ + echo 'Do not use tabs in the manual.' 1>&2; \ + exit 1; \ + fi + +sc_at_in_texi: + @if grep -E '([^@]|^)@([ ][^@]|$$)' $(srcdir)/doc/automake.texi; \ + then \ + echo 'Unescaped @.' 1>&2; \ + exit 1; \ + fi + +$(syntax_check_rules): bin/automake bin/aclocal +maintainer-check: $(syntax_check_rules) +.PHONY: maintainer-check $(syntax_check_rules) + +## Check that the list of tests given in the Makefile is equal to the +## list of all test scripts in the Automake testsuite. +maintainer-check: maintainer-check-list-of-tests + +# I'm a lazy typist. +lint: maintainer-check +.PHONY: lint |