1 # Maintainer checks for Automake. Requires GNU make.
3 # Copyright (C) 2012 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 \
40 ams := $(shell find $(srcdir) -name '*.dir' -prune -o -name '*.am' -print)
42 # Some simple checks, and then ordinary check. These are only really
43 # guaranteed to work on my machine.
44 syntax_check_rules = \
45 $(sc_tests_plain_check_rules) \
46 sc_diff_automake_in_automake \
47 sc_diff_aclocal_in_automake \
49 sc_no_brace_variable_expansions \
51 sc_no_for_variable_in_macro \
53 sc_pre_normal_post_install_uninstall \
55 sc_perl_no_split_regex_space \
58 sc_perl_at_uscore_in_scalar_context \
60 sc_AMDEP_TRUE_in_automake_in \
61 sc_tests_make_without_am_makeflags \
62 $(sc_obsolete_requirements_rules) \
63 sc_tests_obsolete_variables \
64 sc_tests_here_document_format \
65 sc_tests_command_subst \
66 sc_tests_Exit_not_exit \
67 sc_tests_automake_fails \
68 sc_tests_required_after_defs \
69 sc_tests_overriding_macros_on_cmdline \
70 sc_tests_plain_sleep \
73 sc_m4_am_plain_egrep_fgrep \
74 sc_tests_no_configure_in \
75 sc_tests_PATH_SEPARATOR \
76 sc_tests_logs_duplicate_prefixes \
77 sc_tests_makefile_variable_order \
83 ## These check avoids accidental configure substitutions in the source.
84 ## There are exactly 9 lines that should be modified from automake.in to
85 ## automake, and 10 lines that should be modified from aclocal.in to
86 ## aclocal; these wors out to 32 and 34 lines of diffs, respectively.
87 sc_diff_automake_in_automake:
88 @if test `diff $(srcdir)/automake.in automake | wc -l` -ne 32; then \
89 echo "found too many diffs between automake.in and automake" 1>&2; \
90 diff -c $(srcdir)/automake.in automake; \
93 sc_diff_aclocal_in_aclocal:
94 @if test `diff $(srcdir)/aclocal.in aclocal | wc -l` -ne 34; then \
95 echo "found too many diffs between aclocal.in and aclocal" 1>&2; \
96 diff -c $(srcdir)/aclocal.in aclocal; \
100 ## Syntax check with default Perl (on my machine, Perl 5).
102 @perllibdir="./lib$(PATH_SEPARATOR)$(srcdir)/lib" $(PERL) -c -w automake
103 @perllibdir="./lib$(PATH_SEPARATOR)$(srcdir)/lib" $(PERL) -c -w aclocal
105 ## Expect no instances of '${...}'. However, $${...} is ok, since that
106 ## is a shell construct, not a Makefile construct.
107 sc_no_brace_variable_expansions:
108 @if grep -v '^ *#' $(ams) | grep -F '$${' | grep -F -v '$$$$'; then \
109 echo "Found too many uses of '\$${' in the lines above." 1>&2; \
113 ## Make sure 'rm' is called with '-f'.
115 @if grep -v '^#' $(ams) $(xtests) \
116 | grep -vE '/(spy-rm\.tap|subobj-clean.*-pr10697\.sh):' \
117 | grep -E '\<rm ([^-]|\-[^f ]*\>)'; \
119 echo "Suspicious 'rm' invocation." 1>&2; \
123 ## Never use something like "for file in $(FILES)", this doesn't work
124 ## if FILES is empty or if it contains shell meta characters (e.g. $ is
125 ## commonly used in Java filenames).
126 sc_no_for_variable_in_macro:
127 @if grep 'for .* in \$$(' $(ams) | grep -v '/Makefile\.am:'; then \
128 echo 'Use "list=$$(mumble); for var in $$$$list".' 1>&2 ; \
132 ## Make sure all invocations of mkinstalldirs are correct.
134 @if grep -n 'mkinstalldirs' $(ams) \
135 | grep -F -v '$$(mkinstalldirs)' \
136 | grep -v '^\./Makefile.am:[0-9][0-9]*: *lib/mkinstalldirs \\$$'; \
138 echo "Found incorrect use of mkinstalldirs in the lines above" 1>&2; \
142 ## Make sure all calls to PRE/NORMAL/POST_INSTALL/UNINSTALL
143 sc_pre_normal_post_install_uninstall:
144 @if grep -E -n '\((PRE|NORMAL|POST)_(|UN)INSTALL\)' $(ams) | \
145 grep -v ':##' | grep -v ': @\$$('; then \
146 echo "Found incorrect use of PRE/NORMAL/POST_INSTALL/UNINSTALL in the lines above" 1>&2; \
150 ## We never want to use "undef", only "delete", but for $/.
152 @if grep -n -w 'undef ' $(srcdir)/automake.in | \
153 grep -F -v 'undef $$/'; then \
154 echo "Found undef in automake.in; use delete instead" 1>&2; \
158 ## We never want split (/ /,...), only split (' ', ...).
159 sc_perl_no_split_regex_space:
160 @if grep -n 'split (/ /' $(srcdir)/automake.in; then \
161 echo "Found bad split in the lines above." 1>&2; \
165 ## Look for cd within backquotes
167 @if grep -n '^[^#]*` *cd ' $(srcdir)/automake.in $(ams); then \
168 echo "Consider using \$$(am__cd) in the lines above." 1>&2; \
172 ## Look for cd to a relative directory (may be influenced by CDPATH).
173 ## Skip some known directories that are OK.
175 @if grep -n '^[^#]*cd ' $(srcdir)/automake.in $(ams) | \
176 grep -v 'echo.*cd ' | \
177 grep -v 'am__cd =' | \
178 grep -v '^[^#]*cd [./]' | \
179 grep -v '^[^#]*cd \$$(top_builddir)' | \
180 grep -v '^[^#]*cd "\$$\$$am__cwd' | \
181 grep -v '^[^#]*cd \$$(abs' | \
182 grep -v '^[^#]*cd "\$$(DESTDIR)'; then \
183 echo "Consider using \$$(am__cd) in the lines above." 1>&2; \
187 ## Using @_ in a scalar context is most probably a programming error.
188 sc_perl_at_uscore_in_scalar_context:
189 @if grep -Hn '[^@_A-Za-z0-9][_A-Za-z0-9]*[^) ] *= *@_' $(srcdir)/automake.in; then \
190 echo "Using @_ in a scalar context in the lines above." 1>&2; \
194 ## Allow only few variables to be localized in Automake.
196 @if egrep -v '^[ \t]*local \$$[_~]( *=|;)' $(srcdir)/automake.in | \
197 grep '^[ \t]*local [^*]'; then \
198 echo "Please avoid 'local'." 1>&2; \
202 ## Don't let AMDEP_TRUE substitution appear in automake.in.
203 sc_AMDEP_TRUE_in_automake_in:
204 @if grep '@AMDEP''_TRUE@' $(srcdir)/automake.in; then \
205 echo "Don't put AMDEP_TRUE substitution in automake.in" 1>&2; \
209 ## Recursive make invocations should always pass $(AM_MAKEFLAGS)
210 ## to $(MAKE), for portability to non-GNU make.
211 sc_tests_make_without_am_makeflags:
212 @if grep '^[^#].*(MAKE) ' $(ams) $(srcdir)/automake.in \
213 | grep -v 'AM_MAKEFLAGS' \
214 | grep -v '/am/header-vars\.am:.*am--echo.*| $$(MAKE) -f *-'; \
216 echo 'Use $$(MAKE) $$(AM_MAKEFLAGS).' 1>&2; \
220 ## Look out for some obsolete variables.
221 sc_tests_obsolete_variables:
225 test_prefer_config_shell \
232 for v in $$vars; do \
233 if grep -E "\b$$v\b" $(xtests) $(xdefs); then \
237 if test -n "$$seen"; then \
238 for v in $$seen; do \
240 parallel_tests|am_parallel_tests) v2=am_serial_tests;; \
243 echo "Variable '$$v' is obsolete, use '$$v2' instead." 1>&2; \
248 ## Look out for obsolete requirements specified in the test cases.
249 sc_obsolete_requirements_rules = sc_no_texi2dvi-o sc_no_makeinfo-html
250 modern-requirement.texi2dvi-o = texi2dvi
251 modern-requirement.makeinfo-html = makeinfo
253 $(sc_obsolete_requirements_rules): sc_no_% :
254 @if grep -E 'required=.*\b$*\b' $(xtests); then \
255 echo "Requirement '$*' is obsolete and shouldn't" \
256 "be used anymore." >&2; \
257 echo "You should use '$(modern-requirement.$*)' instead." >&2; \
261 ## Tests should never call some programs directly, but only through the
262 ## corresponding variable (e.g., '$MAKE', not 'make'). This will allow
263 ## the programs to be overridden at configure time (for less brittleness)
264 ## or by the user at make time (to allow better testsuite coverage).
265 sc_tests_plain_check_rules = \
266 sc_tests_plain_egrep \
267 sc_tests_plain_fgrep \
268 sc_tests_plain_make \
269 sc_tests_plain_perl \
270 sc_tests_plain_automake \
271 sc_tests_plain_aclocal \
272 sc_tests_plain_autoconf \
273 sc_tests_plain_autoupdate \
274 sc_tests_plain_autom4te \
275 sc_tests_plain_autoheader \
276 sc_tests_plain_autoreconf
278 toupper = $(shell echo $(1) | LC_ALL=C tr '[a-z]' '[A-Z]')
280 $(sc_tests_plain_check_rules): sc_tests_plain_% :
281 @# The leading ':' in the grep below is what is printed by the
282 @# preceding 'grep -v' after the file name.
283 @# It works here as a poor man's substitute for beginning-of-line
285 @if grep -v '^[ ]*#' $(xtests) \
286 | $(EGREP) '(:|\bif|\bnot|[;!{\|\(]|&&|\|\|)[ ]*?$*\b'; \
288 echo 'Do not run "$*" in the above tests.' \
289 'Use "$$$(call toupper,$*)" instead.' 1>&2; \
293 ## Tests should only use END and EOF for here documents
294 ## (so that the next test is effective).
295 sc_tests_here_document_format:
296 @if grep '<<' $(xtests) | grep -Ev '\b(END|EOF)\b|\bcout <<'; then \
297 echo 'Use here documents with "END" and "EOF" only, for greppability.' 1>&2; \
301 ## Our test case should use the $(...) POSIX form for command substitution,
302 ## rather than the older `...` form.
303 ## The point of ignoring text on here-documents is that we want to exempt
304 ## Makefile.am rules, configure.ac code and helper shell script created and
305 ## used by out shell scripts, because Autoconf (as of version 2.69) does not
306 ## yet ensure that $CONFIG_SHELL will be set to a proper POSIX shell.
307 sc_tests_command_subst:
311 -e '/<<.*END/,/^END/b' -e '/<<.*EOF/,/^EOF/b' \
312 -e 's/\\`/\\{backtick}/' \
313 -e "s/[^\\]'\([^']*\`[^']*\)*'/'{quoted-text}'/g" \
316 for file in $(xtests); do \
318 if test -n "$$res"; then \
319 echo "$$file:$$res"; \
324 echo 'Use $$(...), not `...`, for command substitutions.' >&2; \
328 ## Tests should no more call 'Exit', just 'exit'. That's because we
329 ## now have in place a better workaround to ensure the exit status is
330 ## transported correctly across the exit trap.
331 sc_tests_Exit_not_exit:
332 @if grep 'Exit' $(xtests) $(xdefs) | grep -Ev '^[^:]+: *#' | grep .; then \
333 echo "Use 'exit', not 'Exit'; it's obsolete now." 1>&2; \
337 ## Use AUTOMAKE_fails when appropriate
338 sc_tests_automake_fails:
339 @if grep -v '^#' $(xtests) | grep '\$$AUTOMAKE.*&&.*exit'; then \
340 echo 'Use AUTOMAKE_fails + grep to catch automake failures in the above tests.' 1>&2; \
344 ## Setting 'required' after sourcing './defs' is a bug.
345 sc_tests_required_after_defs:
346 @for file in $(xtests); do \
347 if out=`sed -n '/defs/,$${/required=/p;}' $$file`; test -n "$$out"; then \
348 echo 'Do not set "required" after sourcing "defs" in '"$$file: $$out" 1>&2; \
353 ## Overriding a Makefile macro on the command line is not portable when
354 ## recursive targets are used. Better use an envvar. SHELL is an
355 ## exception, POSIX says it can't come from the environment. V, DESTDIR,
356 ## DISTCHECK_CONFIGURE_FLAGS and DISABLE_HARD_ERRORS are exceptions, too,
357 ## as package authors are urged not to initialize them anywhere.
358 ## Finally, 'exp' is used by some ad-hoc checks, where we ensure it's
359 ## ok to override it from the command line.
360 sc_tests_overriding_macros_on_cmdline:
361 @if grep -E '\$$MAKE .*(SHELL=.*=|=.*SHELL=)' $(xtests); then \
362 echo 'Rewrite "$$MAKE foo=bar SHELL=$$SHELL" as "foo=bar $$MAKE -e SHELL=$$SHELL"' 1>&2; \
363 echo ' in the above lines, it is more portable.' 1>&2; \
366 # The first s/// tries to account for usages like "$MAKE || st=$?".
367 # 'DISTCHECK_CONFIGURE_FLAGS' and 'exp' are allowed to contain whitespace in
368 # their definitions, hence the more complex last three substitutions below.
369 # Also, the 'make-dryrun.sh' is whitelisted, since there we need to
370 # override variables from the command line in order to cover the expected
372 @tests=`for t in $(xtests); do \
373 case $$t in */make-dryrun.sh);; *) echo $$t;; esac; \
375 if sed -e 's/ || .*//' -e 's/ && .*//' \
376 -e 's/ DESTDIR=[^ ]*/ /' -e 's/ SHELL=[^ ]*/ /' \
377 -e 's/ V=[^ ]*/ /' -e 's/ DISABLE_HARD_ERRORS=[^ ]*/ /' \
378 -e "s/ DISTCHECK_CONFIGURE_FLAGS='[^']*'/ /" \
379 -e 's/ DISTCHECK_CONFIGURE_FLAGS="[^"]*"/ /' \
380 -e 's/ DISTCHECK_CONFIGURE_FLAGS=[^ ]/ /' \
381 -e "s/ exp='[^']*'/ /" \
382 -e 's/ exp="[^"]*"/ /' \
383 -e 's/ exp=[^ ]/ /' \
384 $$tests | grep '\$$MAKE .*='; then \
385 echo 'Rewrite "$$MAKE foo=bar" as "foo=bar $$MAKE -e" in the above lines,' 1>&2; \
386 echo 'it is more portable.' 1>&2; \
389 @if grep 'SHELL=.*\$$MAKE' $(xtests); then \
390 echo '$$MAKE ignores the SHELL envvar, use "$$MAKE SHELL=$$SHELL" in' 1>&2; \
391 echo 'the above lines.' 1>&2; \
395 ## Prefer use of our 'is_newest' auxiliary script over the more hacky
396 ## idiom "test $(ls -1t new old | sed 1q) = new", which is both more
397 ## cumbersome and more fragile.
399 @if LC_ALL=C grep -E '\bls(\s+-[a-zA-Z0-9]+)*\s+-[a-zA-Z0-9]*t' \
401 echo "Use 'is_newest' rather than hacks based on 'ls -t'" 1>&2; \
405 ## Test scripts must be executable.
408 for f in $(xtests); do \
410 t/ax/*|./t/ax/*|$(srcdir)/t/ax/*);; \
411 *) test -x $$f || { echo "$$f: not executable" >&2; st=1; }; \
414 test $$st -eq 0 || echo '$@: some test scripts are not executable' >&2; \
418 ## Never use 'sleep 1' to create files with different timestamps.
419 ## Use '$sleep' instead. Some filesystems (e.g., Windows) have only
420 ## a 2sec resolution.
421 sc_tests_plain_sleep:
422 @if grep -E '\bsleep +[12345]\b' $(xtests); then \
423 echo 'Do not use "sleep x" in the above tests. Use "$$sleep" instead.' 1>&2; \
427 ## fgrep and egrep are not required by POSIX.
428 sc_m4_am_plain_egrep_fgrep:
429 @if grep -E '\b[ef]grep\b' $(ams) $(srcdir)/m4/*.m4; then \
430 echo 'Do not use egrep or fgrep in the above files,' \
431 'they are not portable.' 1>&2; \
435 ## Prefer 'configure.ac' over the obsolescent 'configure.in' as the name
436 ## for configure input files in our testsuite. The latter has been
437 ## deprecated for several years (at least since autoconf 2.50).
438 sc_tests_no_configure_in:
439 @if grep -E '\bconfigure\\*\.in\b' $(xtests) $(xdefs) \
440 | grep -Ev '/backcompat.*\.(sh|tap):' \
441 | grep -Ev '/autodist-configure-no-subdir\.sh:' \
442 | grep -Ev '/(configure|help)\.sh:' \
445 echo "Use 'configure.ac', not 'configure.in', as the name" >&2; \
446 echo "for configure input files in the test cases above." >&2; \
450 ## Rule to ensure that the testsuite has been run before. We don't depend
451 ## on 'check' here, because that would be very wasteful in the common case.
452 ## We could run "make check RECHECK_LOGS=" and avoid toplevel races with
453 ## AM_RECURSIVE_TARGETS. Suggest keeping test directories around for
454 ## greppability of the Makefile.in files.
455 sc_ensure_testsuite_has_run:
456 @if test ! -f '$(TEST_SUITE_LOG)'; then \
457 echo 'Run "env keep_testdirs=yes make check" before' \
458 'running "make maintainer-check"' >&2; \
461 .PHONY: sc_ensure_testsuite_has_run
463 ## Ensure our warning and error messages do not contain duplicate 'warning:' prefixes.
464 ## This test actually depends on the testsuite having been run before.
465 sc_tests_logs_duplicate_prefixes: sc_ensure_testsuite_has_run
466 @if grep -E '(warning|error):.*(warning|error):' t/*.log; then \
467 echo 'Duplicate warning/error message prefixes seen in above tests.' >&2; \
471 ## Ensure variables are listed before rules in Makefile.in files we generate.
472 sc_tests_makefile_variable_order: sc_ensure_testsuite_has_run
474 for file in `find t -name Makefile.in -print`; do \
477 -e '/\\\\$$/{' -e N -e 'b x' -e '}' \
478 -e '# Literal TAB.' \
480 -e '# Allow @ so we match conditionals.' \
481 -e '/^ *[a-zA-Z_@]\{1,\} *=/p' $$file`; \
482 if test -n "$$latevars"; then \
483 echo "Variables are expanded too late in $$file:" >&2; \
484 echo "$$latevars" | sed 's/^/ /' >&2; \
488 test $$st -eq 0 || { \
489 echo 'Ensure variables are expanded before rules' >&2; \
493 ## Using ':' as a PATH separator is not portable.
494 sc_tests_PATH_SEPARATOR:
495 @if grep -E '\bPATH=.*:.*' $(xtests) ; then \
496 echo "Use '\$$PATH_SEPARATOR', not ':', in PATH definitions" \
501 ## Try to make sure all @...@ substitutions are covered by our
502 ## substitution rule.
504 @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' aclocal | wc -l` -ne 0; then \
505 echo "Unresolved @...@ substitution in aclocal" 1>&2; \
508 @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' automake | wc -l` -ne 0; then \
509 echo "Unresolved @...@ substitution in automake" 1>&2; \
514 @if grep -E "[^\'\"]\\\$$\(DESTDIR" $(ams); then \
515 echo 'Suspicious unquoted DESTDIR uses.' 1>&2 ; \
520 @if grep ' ' $(srcdir)/doc/automake.texi; then \
521 echo 'Do not use tabs in the manual.' 1>&2; \
526 @if grep -E '([^@]|^)@([ ][^@]|$$)' $(srcdir)/doc/automake.texi; \
528 echo 'Unescaped @.' 1>&2; \
532 $(syntax_check_rules): automake aclocal
533 maintainer-check: $(syntax_check_rules)
534 .PHONY: maintainer-check $(syntax_check_rules)
536 ## Check that the list of tests given in the Makefile is equal to the
537 ## list of all test scripts in the Automake testsuite.
538 maintainer-check: maintainer-check-list-of-tests