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_no_run_make_redirect \
66 sc_tests_exit_not_Exit \
67 sc_tests_automake_fails \
68 sc_tests_required_after_defs \
69 sc_tests_overriding_macros_on_cmdline \
71 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 8 lines that should be modified from automake.in to
85 ## automake, and 9 lines that should be modified from aclocal.in to
89 sc_diff_automake sc_diff_aclocal: sc_diff_% :
90 @set +e; tmp=$*-diffs.tmp; \
91 diff -u $(srcdir)/$*.in $* > $$tmp; test $$? -eq 1 || exit 1; \
92 added=`grep -v '^+++ ' $$tmp | grep -c '^+'` || exit 1; \
93 removed=`grep -v '^--- ' $$tmp | grep -c '^-'` || exit 1; \
94 test $$added,$$removed = $($*_diff_no),$($*_diff_no) \
96 echo "Found unexpected diffs between $*.in and $*"; \
97 echo "Lines added: $$added" ; \
98 echo "Lines removed: $$removed"; \
104 ## Expect no instances of '${...}'. However, $${...} is ok, since that
105 ## is a shell construct, not a Makefile construct.
106 sc_no_brace_variable_expansions:
107 @if grep -v '^ *#' $(ams) | grep -F '$${' | grep -F -v '$$$$'; then \
108 echo "Found too many uses of '\$${' in the lines above." 1>&2; \
112 ## Make sure 'rm' is called with '-f'.
114 @if grep -v '^#' $(ams) $(xtests) \
115 | grep -vE '/(spy-rm\.tap|subobj-clean.*-pr10697\.sh):' \
116 | grep -E '\<rm ([^-]|\-[^f ]*\>)'; \
118 echo "Suspicious 'rm' invocation." 1>&2; \
122 ## Never use something like "for file in $(FILES)", this doesn't work
123 ## if FILES is empty or if it contains shell meta characters (e.g. $ is
124 ## commonly used in Java filenames).
125 sc_no_for_variable_in_macro:
126 @if grep 'for .* in \$$(' $(ams) | grep -v '/Makefile\.am:'; then \
127 echo 'Use "list=$$(mumble); for var in $$$$list".' 1>&2 ; \
131 ## Make sure all invocations of mkinstalldirs are correct.
133 @if grep -n 'mkinstalldirs' $(ams) \
134 | grep -F -v '$$(mkinstalldirs)' \
135 | grep -v '^\./Makefile.am:[0-9][0-9]*: *lib/mkinstalldirs \\$$'; \
137 echo "Found incorrect use of mkinstalldirs in the lines above" 1>&2; \
141 ## Make sure all calls to PRE/NORMAL/POST_INSTALL/UNINSTALL
142 sc_pre_normal_post_install_uninstall:
143 @if grep -E -n '\((PRE|NORMAL|POST)_(|UN)INSTALL\)' $(ams) | \
144 grep -v ':##' | grep -v ': @\$$('; then \
145 echo "Found incorrect use of PRE/NORMAL/POST_INSTALL/UNINSTALL in the lines above" 1>&2; \
149 ## We never want to use "undef", only "delete", but for $/.
151 @if grep -n -w 'undef ' $(srcdir)/automake.in | \
152 grep -F -v 'undef $$/'; then \
153 echo "Found undef in automake.in; use delete instead" 1>&2; \
157 ## We never want split (/ /,...), only split (' ', ...).
158 sc_perl_no_split_regex_space:
159 @if grep -n 'split (/ /' $(srcdir)/automake.in; then \
160 echo "Found bad split in the lines above." 1>&2; \
164 ## Look for cd within backquotes
166 @if grep -n '^[^#]*` *cd ' $(srcdir)/automake.in $(ams); then \
167 echo "Consider using \$$(am__cd) in the lines above." 1>&2; \
171 ## Look for cd to a relative directory (may be influenced by CDPATH).
172 ## Skip some known directories that are OK.
174 @if grep -n '^[^#]*cd ' $(srcdir)/automake.in $(ams) | \
175 grep -v 'echo.*cd ' | \
176 grep -v 'am__cd =' | \
177 grep -v '^[^#]*cd [./]' | \
178 grep -v '^[^#]*cd \$$(top_builddir)' | \
179 grep -v '^[^#]*cd "\$$\$$am__cwd' | \
180 grep -v '^[^#]*cd \$$(abs' | \
181 grep -v '^[^#]*cd "\$$(DESTDIR)'; then \
182 echo "Consider using \$$(am__cd) in the lines above." 1>&2; \
186 ## Using @_ in a scalar context is most probably a programming error.
187 sc_perl_at_uscore_in_scalar_context:
188 @if grep -Hn '[^@_A-Za-z0-9][_A-Za-z0-9]*[^) ] *= *@_' $(srcdir)/automake.in; then \
189 echo "Using @_ in a scalar context in the lines above." 1>&2; \
193 ## Allow only few variables to be localized in Automake.
195 @if egrep -v '^[ \t]*local \$$[_~]( *=|;)' $(srcdir)/automake.in | \
196 grep '^[ \t]*local [^*]'; then \
197 echo "Please avoid 'local'." 1>&2; \
201 ## Don't let AMDEP_TRUE substitution appear in automake.in.
202 sc_AMDEP_TRUE_in_automake_in:
203 @if grep '@AMDEP''_TRUE@' $(srcdir)/automake.in; then \
204 echo "Don't put AMDEP_TRUE substitution in automake.in" 1>&2; \
208 ## Recursive make invocations should always pass $(AM_MAKEFLAGS)
209 ## to $(MAKE), for portability to non-GNU make.
210 sc_tests_make_without_am_makeflags:
211 @if grep '^[^#].*(MAKE) ' $(ams) $(srcdir)/automake.in \
212 | grep -Fv '$$(AM_MAKEFLAGS)'; \
214 echo 'Use $$(MAKE) $$(AM_MAKEFLAGS).' 1>&2; \
218 ## Look out for some obsolete variables.
219 sc_tests_obsolete_variables:
223 test_prefer_config_shell \
230 for v in $$vars; do \
231 if grep -E "\b$$v\b" $(xtests) $(xdefs); then \
235 if test -n "$$seen"; then \
236 for v in $$seen; do \
238 parallel_tests|am_parallel_tests) v2=am_serial_tests;; \
241 echo "Variable '$$v' is obsolete, use '$$v2' instead." 1>&2; \
246 ## Look out for obsolete requirements specified in the test cases.
247 sc_obsolete_requirements_rules = sc_no_texi2dvi-o sc_no_makeinfo-html
248 modern-requirement.texi2dvi-o = texi2dvi
249 modern-requirement.makeinfo-html = makeinfo
251 $(sc_obsolete_requirements_rules): sc_no_% :
252 @if grep -E 'required=.*\b$*\b' $(xtests); then \
253 echo "Requirement '$*' is obsolete and shouldn't" \
254 "be used anymore." >&2; \
255 echo "You should use '$(modern-requirement.$*)' instead." >&2; \
259 ## Tests should never call some programs directly, but only through the
260 ## corresponding variable (e.g., '$MAKE', not 'make'). This will allow
261 ## the programs to be overridden at configure time (for less brittleness)
262 ## or by the user at make time (to allow better testsuite coverage).
263 sc_tests_plain_check_rules = \
264 sc_tests_plain_egrep \
265 sc_tests_plain_fgrep \
266 sc_tests_plain_make \
267 sc_tests_plain_perl \
268 sc_tests_plain_automake \
269 sc_tests_plain_aclocal \
270 sc_tests_plain_autoconf \
271 sc_tests_plain_autoupdate \
272 sc_tests_plain_autom4te \
273 sc_tests_plain_autoheader \
274 sc_tests_plain_autoreconf
276 toupper = $(shell echo $(1) | LC_ALL=C tr '[a-z]' '[A-Z]')
278 $(sc_tests_plain_check_rules): sc_tests_plain_% :
279 @# The leading ':' in the grep below is what is printed by the
280 @# preceding 'grep -v' after the file name.
281 @# It works here as a poor man's substitute for beginning-of-line
283 @if grep -v '^[ ]*#' $(xtests) \
284 | $(EGREP) '(:|\bif|\bnot|[;!{\|\(]|&&|\|\|)[ ]*?$*\b'; \
286 echo 'Do not run "$*" in the above tests.' \
287 'Use "$$$(call toupper,$*)" instead.' 1>&2; \
291 ## Tests should only use END and EOF for here documents
292 ## (so that the next test is effective).
293 sc_tests_here_document_format:
294 @if grep '<<' $(xtests) | grep -Ev '\b(END|EOF)\b|\bcout <<'; then \
295 echo 'Use here documents with "END" and "EOF" only, for greppability.' 1>&2; \
299 ## Our test case should use the $(...) POSIX form for command substitution,
300 ## rather than the older `...` form.
301 ## The point of ignoring text on here-documents is that we want to exempt
302 ## Makefile.am rules, configure.ac code and helper shell script created and
303 ## used by out shell scripts, because Autoconf (as of version 2.69) does not
304 ## yet ensure that $CONFIG_SHELL will be set to a proper POSIX shell.
305 sc_tests_command_subst:
309 -e '/<<.*END/,/^END/b' -e '/<<.*EOF/,/^EOF/b' \
310 -e 's/\\`/\\{backtick}/' \
311 -e "s/[^\\]'\([^']*\`[^']*\)*'/'{quoted-text}'/g" \
314 for file in $(xtests); do \
316 if test -n "$$res"; then \
317 echo "$$file:$$res"; \
322 echo 'Use $$(...), not `...`, for command substitutions.' >&2; \
326 ## Tests should no longer call 'Exit', just 'exit'. That's because we
327 ## now have in place a better workaround to ensure the exit status is
328 ## transported correctly across the exit trap.
329 sc_tests_exit_not_Exit:
330 @if grep 'Exit' $(xtests) $(xdefs) | grep -Ev '^[^:]+: *#' | grep .; then \
331 echo "Use 'exit', not 'Exit'; it's obsolete now." 1>&2; \
335 ## Guard against obsolescent uses of ./defs in tests. Now,
336 ## 'test-init.sh' should be used instead.
337 sc_tests_no_source_defs:
338 @if grep -E '\. .*defs($$| )' $(xtests); then \
339 echo "Source 'test-init.sh', not './defs'." 1>&2; \
343 ## Invocation of 'run_make' should not have output redirections.
344 sc_tests_no_run_make_redirect:
345 @if grep -Pzo '.*\brun_make\b(.*(\\\n))*.*>.*' $(xtests); then \
346 echo 'Do not redirect "run_make" invocations, use' \
347 '"run_make {-E|-O|-M}" instead.' 1>&2; \
351 ## Use AUTOMAKE_fails when appropriate
352 sc_tests_automake_fails:
353 @if grep -v '^#' $(xtests) | grep '\$$AUTOMAKE.*&&.*exit'; then \
354 echo 'Use AUTOMAKE_fails + grep to catch automake failures in the above tests.' 1>&2; \
358 ## Setting 'required' after sourcing 'test-init.sh' is a bug.
359 sc_tests_required_after_defs:
360 @for file in $(xtests); do \
361 if out=`sed -n '/test-init\.sh/,$${/required=/p;}' $$file`; test -n "$$out"; then \
362 echo 'Do not set "required" after sourcing "test-init.sh" in '"$$file: $$out" 1>&2; \
367 # "make -e" is brittle and unsafe, since it let *all* the environment
368 # win over the macro definitions in the Makefiles. Since we offer
369 # AM_MAKEFLAGS to allow the user to portably override macro definitions
370 # from the command line in a safe way, we should encourage users to use
373 @if grep -E '\$$MAKE\b.* -[a-zA-Z0-9]*e' $(xtests); then \
374 echo '"make -e" is brittle, use "run_make" instead.' 1>&2; \
378 ## Overriding a Makefile macro on the command line is not portable when
379 ## recursive targets are used. Better use an envvar. SHELL is an
380 ## exception, POSIX says it can't come from the environment. V, DESTDIR,
381 ## DISTCHECK_CONFIGURE_FLAGS and DISABLE_HARD_ERRORS are exceptions, too,
382 ## as package authors are urged not to initialize them anywhere.
383 ## Finally, 'exp' is used by some ad-hoc checks, where we ensure it's
384 ## ok to override it from the command line.
385 sc_tests_overriding_macros_on_cmdline:
386 # The first s/// tries to account for usages like "$MAKE || st=$?".
387 # 'DISTCHECK_CONFIGURE_FLAGS' and 'exp' are allowed to contain whitespace in
388 # their definitions, hence the more complex last three substitutions below.
389 @if sed -e 's/ || .*//' -e 's/ && .*//' \
390 -e 's/ DESTDIR=[^ ]*/ /' -e 's/ SHELL=[^ ]*/ /' \
391 -e 's/ V=[^ ]*/ /' -e 's/ DISABLE_HARD_ERRORS=[^ ]*/ /' \
392 -e "s/ DISTCHECK_CONFIGURE_FLAGS='[^']*'/ /" \
393 -e 's/ DISTCHECK_CONFIGURE_FLAGS="[^"]*"/ /' \
394 -e 's/ DISTCHECK_CONFIGURE_FLAGS=[^ ]/ /' \
395 -e "s/ exp='[^']*'/ /" \
396 -e 's/ exp="[^"]*"/ /' \
397 -e 's/ exp=[^ ]/ /' \
398 $(filter-out %/am-test-lib.sh,$(xtests)) \
399 | grep '\$$MAKE .*='; then \
400 echo 'Rewrite "$$MAKE foo=bar" as "run_make foo=bar" in the lines above,'; \
401 echo 'it is more portable.'; \
404 @if grep 'SHELL=.*\$$MAKE' $(xtests); then \
405 echo '$$MAKE ignores the SHELL envvar, use "run_make SHELL=$$SHELL"'; \
406 echo 'in the above lines.'; \
410 ## Prefer use of our 'is_newest' auxiliary script over the more hacky
411 ## idiom "test $(ls -1t new old | sed 1q) = new", which is both more
412 ## cumbersome and more fragile.
414 @if LC_ALL=C grep -E '\bls(\s+-[a-zA-Z0-9]+)*\s+-[a-zA-Z0-9]*t' \
416 echo "Use 'is_newest' rather than hacks based on 'ls -t'" 1>&2; \
420 ## Never use 'sleep 1' to create files with different timestamps.
421 ## Use '$sleep' instead. Some file systems (e.g., Windows) have only
422 ## a 2sec resolution.
423 sc_tests_plain_sleep:
424 @if grep -E '\bsleep +[12345]\b' $(xtests); then \
425 echo 'Do not use "sleep x" in the above tests. Use "$$sleep" instead.' 1>&2; \
429 ## fgrep and egrep are not required by POSIX.
430 sc_m4_am_plain_egrep_fgrep:
431 @if grep -E '\b[ef]grep\b' $(ams) $(srcdir)/m4/*.m4; then \
432 echo 'Do not use egrep or fgrep in the above files,' \
433 'they are not portable.' 1>&2; \
437 ## Prefer 'configure.ac' over the obsolescent 'configure.in' as the name
438 ## for configure input files in our testsuite. The latter has been
439 ## deprecated for several years (at least since autoconf 2.50).
440 sc_tests_no_configure_in:
441 @if grep -E '\bconfigure\\*\.in\b' $(xtests) $(xdefs) \
442 | grep -Ev '/backcompat.*\.(sh|tap):' \
443 | grep -Ev '/autodist-configure-no-subdir\.sh:' \
444 | grep -Ev '/(configure|help)\.sh:' \
447 echo "Use 'configure.ac', not 'configure.in', as the name" >&2; \
448 echo "for configure input files in the test cases above." >&2; \
452 ## Rule to ensure that the testsuite has been run before. We don't depend
453 ## on 'check' here, because that would be very wasteful in the common case.
454 ## We could run "make check RECHECK_LOGS=" and avoid toplevel races with
455 ## AM_RECURSIVE_TARGETS. Suggest keeping test directories around for
456 ## greppability of the Makefile.in files.
457 sc_ensure_testsuite_has_run:
458 @if test ! -f '$(TEST_SUITE_LOG)'; then \
459 echo 'Run "env keep_testdirs=yes make check" before' \
460 'running "make maintainer-check"' >&2; \
463 .PHONY: sc_ensure_testsuite_has_run
465 ## Ensure our warning and error messages do not contain duplicate 'warning:' prefixes.
466 ## This test actually depends on the testsuite having been run before.
467 sc_tests_logs_duplicate_prefixes: sc_ensure_testsuite_has_run
468 @if grep -E '(warning|error):.*(warning|error):' t/*.log; then \
469 echo 'Duplicate warning/error message prefixes seen in above tests.' >&2; \
473 ## Ensure variables are listed before rules in Makefile.in files we generate.
474 sc_tests_makefile_variable_order: sc_ensure_testsuite_has_run
476 for file in `find t -name Makefile.in -print`; do \
479 -e '/\\\\$$/{' -e N -e 'b x' -e '}' \
480 -e '# Literal TAB.' \
482 -e '# Allow @ so we match conditionals.' \
483 -e '/^ *[a-zA-Z_@]\{1,\} *=/p' $$file`; \
484 if test -n "$$latevars"; then \
485 echo "Variables are expanded too late in $$file:" >&2; \
486 echo "$$latevars" | sed 's/^/ /' >&2; \
490 test $$st -eq 0 || { \
491 echo 'Ensure variables are expanded before rules' >&2; \
495 ## Using ':' as a PATH separator is not portable.
496 sc_tests_PATH_SEPARATOR:
497 @if grep -E '\bPATH=.*:.*' $(xtests) ; then \
498 echo "Use '\$$PATH_SEPARATOR', not ':', in PATH definitions" \
503 ## Try to make sure all @...@ substitutions are covered by our
504 ## substitution rule.
506 @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' aclocal | wc -l` -ne 0; then \
507 echo "Unresolved @...@ substitution in aclocal" 1>&2; \
510 @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' automake | wc -l` -ne 0; then \
511 echo "Unresolved @...@ substitution in automake" 1>&2; \
516 @if grep -E "[^\'\"]\\\$$\(DESTDIR" $(ams); then \
517 echo 'Suspicious unquoted DESTDIR uses.' 1>&2 ; \
522 @if grep ' ' $(srcdir)/doc/automake.texi; then \
523 echo 'Do not use tabs in the manual.' 1>&2; \
528 @if grep -E '([^@]|^)@([ ][^@]|$$)' $(srcdir)/doc/automake.texi; \
530 echo 'Unescaped @.' 1>&2; \
534 $(syntax_check_rules): automake aclocal
535 maintainer-check: $(syntax_check_rules)
536 .PHONY: maintainer-check $(syntax_check_rules)
538 ## Check that the list of tests given in the Makefile is equal to the
539 ## list of all test scripts in the Automake testsuite.
540 maintainer-check: maintainer-check-list-of-tests
543 lint: maintainer-check