1 # Maintainer checks for Automake. Requires GNU make.
3 # Copyright (C) 2012-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 # We also have to take into account VPATH builds (where some generated
19 # tests might be in '$(builddir)' rather than in '$(srcdir)'), TAP-based
20 # tests script (which have a '.tap' extension) and helper scripts used
21 # by other test cases (which have a '.sh' extension).
23 if test $(srcdir) = .; then \
30 ls $$d/t/ax/*.$$s $$d/t/*.$$s $$d/contrib/t/*.$$s 2>/dev/null; \
35 $(srcdir)/t/ax/am-test-lib.sh \
36 $(srcdir)/t/ax/test-lib.sh \
37 $(srcdir)/t/ax/test-defs.in
39 ams := $(shell find $(srcdir) -name '*.dir' -prune -o -name '*.am' -print)
41 # Some simple checks, and then ordinary check. These are only really
42 # guaranteed to work on my machine.
43 syntax_check_rules = \
44 $(sc_tests_plain_check_rules) \
47 sc_no_brace_variable_expansions \
49 sc_no_for_variable_in_macro \
51 sc_pre_normal_post_install_uninstall \
53 sc_perl_no_split_regex_space \
56 sc_perl_at_uscore_in_scalar_context \
58 sc_AMDEP_TRUE_in_automake_in \
59 sc_tests_make_without_am_makeflags \
60 $(sc_obsolete_requirements_rules) \
61 sc_tests_no_source_defs \
62 sc_tests_obsolete_variables \
63 sc_tests_here_document_format \
64 sc_tests_command_subst \
65 sc_tests_exit_not_Exit \
66 sc_tests_automake_fails \
67 sc_tests_required_after_defs \
68 sc_tests_overriding_macros_on_cmdline \
69 sc_tests_plain_sleep \
71 sc_m4_am_plain_egrep_fgrep \
72 sc_tests_no_configure_in \
73 sc_tests_PATH_SEPARATOR \
74 sc_tests_logs_duplicate_prefixes \
75 sc_tests_makefile_variable_order \
81 ## These check avoids accidental configure substitutions in the source.
82 ## There are exactly 8 lines that should be modified from automake.in to
83 ## automake, and 9 lines that should be modified from aclocal.in to
87 sc_diff_automake sc_diff_aclocal: sc_diff_% :
88 @set +e; tmp=$*-diffs.tmp; \
89 diff -u $(srcdir)/$*.in $* > $$tmp; test $$? -eq 1 || exit 1; \
90 added=`grep -v '^+++ ' $$tmp | grep -c '^+'` || exit 1; \
91 removed=`grep -v '^--- ' $$tmp | grep -c '^-'` || exit 1; \
92 test $$added,$$removed = $($*_diff_no),$($*_diff_no) \
94 echo "Found unexpected diffs between $*.in and $*"; \
95 echo "Lines added: $$added" ; \
96 echo "Lines removed: $$removed"; \
102 ## Expect no instances of '${...}'. However, $${...} is ok, since that
103 ## is a shell construct, not a Makefile construct.
104 sc_no_brace_variable_expansions:
105 @if grep -v '^ *#' $(ams) | grep -F '$${' | grep -F -v '$$$$'; then \
106 echo "Found too many uses of '\$${' in the lines above." 1>&2; \
110 ## Make sure 'rm' is called with '-f'.
112 @if grep -v '^#' $(ams) $(xtests) \
113 | grep -vE '/(spy-rm\.tap|subobj-clean.*-pr10697\.sh):' \
114 | grep -E '\<rm ([^-]|\-[^f ]*\>)'; \
116 echo "Suspicious 'rm' invocation." 1>&2; \
120 ## Never use something like "for file in $(FILES)", this doesn't work
121 ## if FILES is empty or if it contains shell meta characters (e.g. $ is
122 ## commonly used in Java filenames).
123 sc_no_for_variable_in_macro:
124 @if grep 'for .* in \$$(' $(ams) | grep -v '/Makefile\.am:'; then \
125 echo 'Use "list=$$(mumble); for var in $$$$list".' 1>&2 ; \
129 ## Make sure all invocations of mkinstalldirs are correct.
131 @if grep -n 'mkinstalldirs' $(ams) \
132 | grep -F -v '$$(mkinstalldirs)' \
133 | grep -v '^\./Makefile.am:[0-9][0-9]*: *lib/mkinstalldirs \\$$'; \
135 echo "Found incorrect use of mkinstalldirs in the lines above" 1>&2; \
139 ## Make sure all calls to PRE/NORMAL/POST_INSTALL/UNINSTALL
140 sc_pre_normal_post_install_uninstall:
141 @if grep -E -n '\((PRE|NORMAL|POST)_(|UN)INSTALL\)' $(ams) | \
142 grep -v ':##' | grep -v ': @\$$('; then \
143 echo "Found incorrect use of PRE/NORMAL/POST_INSTALL/UNINSTALL in the lines above" 1>&2; \
147 ## We never want to use "undef", only "delete", but for $/.
149 @if grep -n -w 'undef ' $(srcdir)/automake.in | \
150 grep -F -v 'undef $$/'; then \
151 echo "Found undef in automake.in; use delete instead" 1>&2; \
155 ## We never want split (/ /,...), only split (' ', ...).
156 sc_perl_no_split_regex_space:
157 @if grep -n 'split (/ /' $(srcdir)/automake.in; then \
158 echo "Found bad split in the lines above." 1>&2; \
162 ## Look for cd within backquotes
164 @if grep -n '^[^#]*` *cd ' $(srcdir)/automake.in $(ams); then \
165 echo "Consider using \$$(am__cd) in the lines above." 1>&2; \
169 ## Look for cd to a relative directory (may be influenced by CDPATH).
170 ## Skip some known directories that are OK.
172 @if grep -n '^[^#]*cd ' $(srcdir)/automake.in $(ams) | \
173 grep -v 'echo.*cd ' | \
174 grep -v 'am__cd =' | \
175 grep -v '^[^#]*cd [./]' | \
176 grep -v '^[^#]*cd \$$(top_builddir)' | \
177 grep -v '^[^#]*cd "\$$\$$am__cwd' | \
178 grep -v '^[^#]*cd \$$(abs' | \
179 grep -v '^[^#]*cd "\$$(DESTDIR)'; then \
180 echo "Consider using \$$(am__cd) in the lines above." 1>&2; \
184 ## Using @_ in a scalar context is most probably a programming error.
185 sc_perl_at_uscore_in_scalar_context:
186 @if grep -Hn '[^@_A-Za-z0-9][_A-Za-z0-9]*[^) ] *= *@_' $(srcdir)/automake.in; then \
187 echo "Using @_ in a scalar context in the lines above." 1>&2; \
191 ## Allow only few variables to be localized in Automake.
193 @if egrep -v '^[ \t]*local \$$[_~]( *=|;)' $(srcdir)/automake.in | \
194 grep '^[ \t]*local [^*]'; then \
195 echo "Please avoid 'local'." 1>&2; \
199 ## Don't let AMDEP_TRUE substitution appear in automake.in.
200 sc_AMDEP_TRUE_in_automake_in:
201 @if grep '@AMDEP''_TRUE@' $(srcdir)/automake.in; then \
202 echo "Don't put AMDEP_TRUE substitution in automake.in" 1>&2; \
206 ## Recursive make invocations should always pass $(AM_MAKEFLAGS)
207 ## to $(MAKE), for portability to non-GNU make.
208 sc_tests_make_without_am_makeflags:
209 @if grep '^[^#].*(MAKE) ' $(ams) $(srcdir)/automake.in \
210 | grep -Fv '$$(AM_MAKEFLAGS)'; \
212 echo 'Use $$(MAKE) $$(AM_MAKEFLAGS).' 1>&2; \
216 ## Look out for some obsolete variables.
217 sc_tests_obsolete_variables:
221 test_prefer_config_shell \
228 for v in $$vars; do \
229 if grep -E "\b$$v\b" $(xtests) $(xdefs); then \
233 if test -n "$$seen"; then \
234 for v in $$seen; do \
236 parallel_tests|am_parallel_tests) v2=am_serial_tests;; \
239 echo "Variable '$$v' is obsolete, use '$$v2' instead." 1>&2; \
244 ## Look out for obsolete requirements specified in the test cases.
245 sc_obsolete_requirements_rules = sc_no_texi2dvi-o sc_no_makeinfo-html
246 modern-requirement.texi2dvi-o = texi2dvi
247 modern-requirement.makeinfo-html = makeinfo
249 $(sc_obsolete_requirements_rules): sc_no_% :
250 @if grep -E 'required=.*\b$*\b' $(xtests); then \
251 echo "Requirement '$*' is obsolete and shouldn't" \
252 "be used anymore." >&2; \
253 echo "You should use '$(modern-requirement.$*)' instead." >&2; \
257 ## Tests should never call some programs directly, but only through the
258 ## corresponding variable (e.g., '$MAKE', not 'make'). This will allow
259 ## the programs to be overridden at configure time (for less brittleness)
260 ## or by the user at make time (to allow better testsuite coverage).
261 sc_tests_plain_check_rules = \
262 sc_tests_plain_egrep \
263 sc_tests_plain_fgrep \
264 sc_tests_plain_make \
265 sc_tests_plain_perl \
266 sc_tests_plain_automake \
267 sc_tests_plain_aclocal \
268 sc_tests_plain_autoconf \
269 sc_tests_plain_autoupdate \
270 sc_tests_plain_autom4te \
271 sc_tests_plain_autoheader \
272 sc_tests_plain_autoreconf
274 toupper = $(shell echo $(1) | LC_ALL=C tr '[a-z]' '[A-Z]')
276 $(sc_tests_plain_check_rules): sc_tests_plain_% :
277 @# The leading ':' in the grep below is what is printed by the
278 @# preceding 'grep -v' after the file name.
279 @# It works here as a poor man's substitute for beginning-of-line
281 @if grep -v '^[ ]*#' $(xtests) \
282 | $(EGREP) '(:|\bif|\bnot|[;!{\|\(]|&&|\|\|)[ ]*?$*\b'; \
284 echo 'Do not run "$*" in the above tests.' \
285 'Use "$$$(call toupper,$*)" instead.' 1>&2; \
289 ## Tests should only use END and EOF for here documents
290 ## (so that the next test is effective).
291 sc_tests_here_document_format:
292 @if grep '<<' $(xtests) | grep -Ev '\b(END|EOF)\b|\bcout <<'; then \
293 echo 'Use here documents with "END" and "EOF" only, for greppability.' 1>&2; \
297 ## Our test case should use the $(...) POSIX form for command substitution,
298 ## rather than the older `...` form.
299 ## The point of ignoring text on here-documents is that we want to exempt
300 ## Makefile.am rules, configure.ac code and helper shell script created and
301 ## used by out shell scripts, because Autoconf (as of version 2.69) does not
302 ## yet ensure that $CONFIG_SHELL will be set to a proper POSIX shell.
303 sc_tests_command_subst:
307 -e '/<<.*END/,/^END/b' -e '/<<.*EOF/,/^EOF/b' \
308 -e 's/\\`/\\{backtick}/' \
309 -e "s/[^\\]'\([^']*\`[^']*\)*'/'{quoted-text}'/g" \
312 for file in $(xtests); do \
314 if test -n "$$res"; then \
315 echo "$$file:$$res"; \
320 echo 'Use $$(...), not `...`, for command substitutions.' >&2; \
324 ## Tests should no longer call 'Exit', just 'exit'. That's because we
325 ## now have in place a better workaround to ensure the exit status is
326 ## transported correctly across the exit trap.
327 sc_tests_exit_not_Exit:
328 @if grep 'Exit' $(xtests) $(xdefs) | grep -Ev '^[^:]+: *#' | grep .; then \
329 echo "Use 'exit', not 'Exit'; it's obsolete now." 1>&2; \
333 ## Guard against obsolescent uses of ./defs in tests. Now,
334 ## 'test-init.sh' should be used instead.
335 sc_tests_no_source_defs:
336 @if grep -E '\. .*defs($$| )' $(xtests); then \
337 echo "Source 'test-init.sh', not './defs'." 1>&2; \
341 ## Use AUTOMAKE_fails when appropriate
342 sc_tests_automake_fails:
343 @if grep -v '^#' $(xtests) | grep '\$$AUTOMAKE.*&&.*exit'; then \
344 echo 'Use AUTOMAKE_fails + grep to catch automake failures in the above tests.' 1>&2; \
348 ## Setting 'required' after sourcing 'test-init.sh' is a bug.
349 sc_tests_required_after_defs:
350 @for file in $(xtests); do \
351 if out=`sed -n '/test-init\.sh/,$${/required=/p;}' $$file`; test -n "$$out"; then \
352 echo 'Do not set "required" after sourcing "test-init.sh" in '"$$file: $$out" 1>&2; \
357 ## Overriding a Makefile macro on the command line is not portable when
358 ## recursive targets are used. Better use an envvar. SHELL is an
359 ## exception, POSIX says it can't come from the environment. V, DESTDIR,
360 ## DISTCHECK_CONFIGURE_FLAGS and DISABLE_HARD_ERRORS are exceptions, too,
361 ## as package authors are urged not to initialize them anywhere.
362 ## Finally, 'exp' is used by some ad-hoc checks, where we ensure it's
363 ## ok to override it from the command line.
364 sc_tests_overriding_macros_on_cmdline:
365 @if grep -E '\$$MAKE .*(SHELL=.*=|=.*SHELL=)' $(xtests); then \
366 echo 'Rewrite "$$MAKE foo=bar SHELL=$$SHELL" as "foo=bar $$MAKE -e SHELL=$$SHELL"' 1>&2; \
367 echo ' in the above lines, it is more portable.' 1>&2; \
370 # The first s/// tries to account for usages like "$MAKE || st=$?".
371 # 'DISTCHECK_CONFIGURE_FLAGS' and 'exp' are allowed to contain whitespace in
372 # their definitions, hence the more complex last three substitutions below.
373 @if sed -e 's/ || .*//' -e 's/ && .*//' \
374 -e 's/ DESTDIR=[^ ]*/ /' -e 's/ SHELL=[^ ]*/ /' \
375 -e 's/ V=[^ ]*/ /' -e 's/ DISABLE_HARD_ERRORS=[^ ]*/ /' \
376 -e "s/ DISTCHECK_CONFIGURE_FLAGS='[^']*'/ /" \
377 -e 's/ DISTCHECK_CONFIGURE_FLAGS="[^"]*"/ /' \
378 -e 's/ DISTCHECK_CONFIGURE_FLAGS=[^ ]/ /' \
379 -e "s/ exp='[^']*'/ /" \
380 -e 's/ exp="[^"]*"/ /' \
381 -e 's/ exp=[^ ]/ /' \
382 $(xtests) | grep '\$$MAKE .*='; then \
383 echo 'Rewrite "$$MAKE foo=bar" as "foo=bar $$MAKE -e" in the above lines,' 1>&2; \
384 echo 'it is more portable.' 1>&2; \
387 @if grep 'SHELL=.*\$$MAKE' $(xtests); then \
388 echo '$$MAKE ignores the SHELL envvar, use "$$MAKE SHELL=$$SHELL" in' 1>&2; \
389 echo 'the above lines.' 1>&2; \
393 ## Prefer use of our 'is_newest' auxiliary script over the more hacky
394 ## idiom "test $(ls -1t new old | sed 1q) = new", which is both more
395 ## cumbersome and more fragile.
397 @if LC_ALL=C grep -E '\bls(\s+-[a-zA-Z0-9]+)*\s+-[a-zA-Z0-9]*t' \
399 echo "Use 'is_newest' rather than hacks based on 'ls -t'" 1>&2; \
403 ## Never use 'sleep 1' to create files with different timestamps.
404 ## Use '$sleep' instead. Some file systems (e.g., Windows) have only
405 ## a 2sec resolution.
406 sc_tests_plain_sleep:
407 @if grep -E '\bsleep +[12345]\b' $(xtests); then \
408 echo 'Do not use "sleep x" in the above tests. Use "$$sleep" instead.' 1>&2; \
412 ## fgrep and egrep are not required by POSIX.
413 sc_m4_am_plain_egrep_fgrep:
414 @if grep -E '\b[ef]grep\b' $(ams) $(srcdir)/m4/*.m4; then \
415 echo 'Do not use egrep or fgrep in the above files,' \
416 'they are not portable.' 1>&2; \
420 ## Prefer 'configure.ac' over the obsolescent 'configure.in' as the name
421 ## for configure input files in our testsuite. The latter has been
422 ## deprecated for several years (at least since autoconf 2.50).
423 sc_tests_no_configure_in:
424 @if grep -E '\bconfigure\\*\.in\b' $(xtests) $(xdefs) \
425 | grep -Ev '/backcompat.*\.(sh|tap):' \
426 | grep -Ev '/autodist-configure-no-subdir\.sh:' \
427 | grep -Ev '/(configure|help)\.sh:' \
430 echo "Use 'configure.ac', not 'configure.in', as the name" >&2; \
431 echo "for configure input files in the test cases above." >&2; \
435 ## Rule to ensure that the testsuite has been run before. We don't depend
436 ## on 'check' here, because that would be very wasteful in the common case.
437 ## We could run "make check RECHECK_LOGS=" and avoid toplevel races with
438 ## AM_RECURSIVE_TARGETS. Suggest keeping test directories around for
439 ## greppability of the Makefile.in files.
440 sc_ensure_testsuite_has_run:
441 @if test ! -f '$(TEST_SUITE_LOG)'; then \
442 echo 'Run "env keep_testdirs=yes make check" before' \
443 'running "make maintainer-check"' >&2; \
446 .PHONY: sc_ensure_testsuite_has_run
448 ## Ensure our warning and error messages do not contain duplicate 'warning:' prefixes.
449 ## This test actually depends on the testsuite having been run before.
450 sc_tests_logs_duplicate_prefixes: sc_ensure_testsuite_has_run
451 @if grep -E '(warning|error):.*(warning|error):' t/*.log; then \
452 echo 'Duplicate warning/error message prefixes seen in above tests.' >&2; \
456 ## Ensure variables are listed before rules in Makefile.in files we generate.
457 sc_tests_makefile_variable_order: sc_ensure_testsuite_has_run
459 for file in `find t -name Makefile.in -print`; do \
462 -e '/\\\\$$/{' -e N -e 'b x' -e '}' \
463 -e '# Literal TAB.' \
465 -e '# Allow @ so we match conditionals.' \
466 -e '/^ *[a-zA-Z_@]\{1,\} *=/p' $$file`; \
467 if test -n "$$latevars"; then \
468 echo "Variables are expanded too late in $$file:" >&2; \
469 echo "$$latevars" | sed 's/^/ /' >&2; \
473 test $$st -eq 0 || { \
474 echo 'Ensure variables are expanded before rules' >&2; \
478 ## Using ':' as a PATH separator is not portable.
479 sc_tests_PATH_SEPARATOR:
480 @if grep -E '\bPATH=.*:.*' $(xtests) ; then \
481 echo "Use '\$$PATH_SEPARATOR', not ':', in PATH definitions" \
486 ## Try to make sure all @...@ substitutions are covered by our
487 ## substitution rule.
489 @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' aclocal | wc -l` -ne 0; then \
490 echo "Unresolved @...@ substitution in aclocal" 1>&2; \
493 @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' automake | wc -l` -ne 0; then \
494 echo "Unresolved @...@ substitution in automake" 1>&2; \
499 @if grep -E "[^\'\"]\\\$$\(DESTDIR" $(ams); then \
500 echo 'Suspicious unquoted DESTDIR uses.' 1>&2 ; \
505 @if grep ' ' $(srcdir)/doc/automake.texi; then \
506 echo 'Do not use tabs in the manual.' 1>&2; \
511 @if grep -E '([^@]|^)@([ ][^@]|$$)' $(srcdir)/doc/automake.texi; \
513 echo 'Unescaped @.' 1>&2; \
517 $(syntax_check_rules): automake aclocal
518 maintainer-check: $(syntax_check_rules)
519 .PHONY: maintainer-check $(syntax_check_rules)
521 ## Check that the list of tests given in the Makefile is equal to the
522 ## list of all test scripts in the Automake testsuite.
523 maintainer-check: maintainer-check-list-of-tests