Merge branch 'maint'
[platform/upstream/automake.git] / syntax-checks.mk
1 # Maintainer checks for Automake.  Requires GNU make.
2
3 # Copyright (C) 2012 Free Software Foundation, Inc.
4 #
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)
8 # any later version.
9 #
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.
14 #
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/>.
17
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).
22 xtests := $(shell \
23   if test $(srcdir) = .; then \
24      dirs=.; \
25    else \
26      dirs='$(srcdir) .'; \
27    fi; \
28    for d in $$dirs; do \
29      for s in tap sh; do \
30        ls $$d/t/*.$$s $$d/t/ax/*.$$s 2>/dev/null; \
31      done; \
32    done | sort)
33
34 xdefs = $(srcdir)/t/ax/test-init.sh $(srcdir)/defs $(srcdir)/defs-static.in
35
36 ams := $(shell find $(srcdir) -name '*.dir' -prune -o -name '*.am' -print)
37
38 # Some simple checks, and then ordinary check.  These are only really
39 # guaranteed to work on my machine.
40 syntax_check_rules = \
41 $(sc_tests_plain_check_rules) \
42 sc_diff_automake_in_automake \
43 sc_diff_aclocal_in_automake \
44 sc_perl_syntax \
45 sc_no_brace_variable_expansions \
46 sc_rm_minus_f \
47 sc_no_for_variable_in_macro \
48 sc_mkinstalldirs \
49 sc_pre_normal_post_install_uninstall \
50 sc_perl_no_undef \
51 sc_perl_no_split_regex_space \
52 sc_cd_in_backquotes \
53 sc_cd_relative_dir \
54 sc_perl_at_uscore_in_scalar_context \
55 sc_perl_local \
56 sc_AMDEP_TRUE_in_automake_in \
57 sc_tests_make_without_am_makeflags \
58 $(sc_obsolete_requirements_rules) \
59 sc_tests_obsolete_variables \
60 sc_tests_here_document_format \
61 sc_tests_Exit_not_exit \
62 sc_tests_automake_fails \
63 sc_tests_required_after_defs \
64 sc_tests_overriding_macros_on_cmdline \
65 sc_tests_plain_sleep \
66 sc_tests_ls_t \
67 sc_m4_am_plain_egrep_fgrep \
68 sc_tests_no_configure_in \
69 sc_tests_PATH_SEPARATOR \
70 sc_tests_logs_duplicate_prefixes \
71 sc_tests_makefile_variable_order \
72 sc_perl_at_substs \
73 sc_unquoted_DESTDIR \
74 sc_tabs_in_texi \
75 sc_at_in_texi
76
77 ## These check avoids accidental configure substitutions in the source.
78 ## There are exactly 9 lines that should be modified from automake.in to
79 ## automake, and 10 lines that should be modified from aclocal.in to
80 ## aclocal; these wors out to 32 and 34 lines of diffs, respectively.
81 sc_diff_automake_in_automake:
82         @if test `diff $(srcdir)/automake.in automake | wc -l` -ne 32; then \
83           echo "found too many diffs between automake.in and automake" 1>&2; \
84           diff -c $(srcdir)/automake.in automake; \
85           exit 1; \
86         fi
87 sc_diff_aclocal_in_aclocal:
88         @if test `diff $(srcdir)/aclocal.in aclocal | wc -l` -ne 34; then \
89           echo "found too many diffs between aclocal.in and aclocal" 1>&2; \
90           diff -c $(srcdir)/aclocal.in aclocal; \
91           exit 1; \
92         fi
93
94 ## Syntax check with default Perl (on my machine, Perl 5).
95 sc_perl_syntax:
96         @perllibdir="./lib$(PATH_SEPARATOR)$(srcdir)/lib" $(PERL) -c -w automake
97         @perllibdir="./lib$(PATH_SEPARATOR)$(srcdir)/lib" $(PERL) -c -w aclocal
98
99 ## Expect no instances of '${...}'.  However, $${...} is ok, since that
100 ## is a shell construct, not a Makefile construct.
101 sc_no_brace_variable_expansions:
102         @if grep -v '^ *#' $(ams) | grep -F '$${' | grep -F -v '$$$$'; then \
103           echo "Found too many uses of '\$${' in the lines above." 1>&2; \
104           exit 1;                               \
105         else :; fi
106
107 ## Make sure 'rm' is called with '-f'.
108 sc_rm_minus_f:
109         @if grep -v '^#' $(ams) $(xtests) \
110            | grep -vE '/(spy-rm\.tap|subobj-clean.*-pr10697\.sh):' \
111            | grep -E '\<rm ([^-]|\-[^f ]*\>)'; \
112         then \
113           echo "Suspicious 'rm' invocation." 1>&2; \
114           exit 1;                               \
115         else :; fi
116
117 ## Never use something like "for file in $(FILES)", this doesn't work
118 ## if FILES is empty or if it contains shell meta characters (e.g. $ is
119 ## commonly used in Java filenames).
120 sc_no_for_variable_in_macro:
121         @if grep 'for .* in \$$(' $(ams) | grep -v '/Makefile\.am:'; then \
122           echo 'Use "list=$$(mumble); for var in $$$$list".' 1>&2 ; \
123           exit 1; \
124         else :; fi
125
126 ## Make sure all invocations of mkinstalldirs are correct.
127 sc_mkinstalldirs:
128         @if grep -n 'mkinstalldirs' $(ams) \
129               | grep -F -v '$$(mkinstalldirs)' \
130               | grep -v '^\./Makefile.am:[0-9][0-9]*:  *lib/mkinstalldirs \\$$'; \
131         then \
132           echo "Found incorrect use of mkinstalldirs in the lines above" 1>&2; \
133           exit 1; \
134         else :; fi
135
136 ## Make sure all calls to PRE/NORMAL/POST_INSTALL/UNINSTALL
137 sc_pre_normal_post_install_uninstall:
138         @if grep -E -n '\((PRE|NORMAL|POST)_(|UN)INSTALL\)' $(ams) | \
139               grep -v ':##' | grep -v ':        @\$$('; then \
140           echo "Found incorrect use of PRE/NORMAL/POST_INSTALL/UNINSTALL in the lines above" 1>&2; \
141           exit 1; \
142         else :; fi
143
144 ## We never want to use "undef", only "delete", but for $/.
145 sc_perl_no_undef:
146         @if grep -n -w 'undef ' $(srcdir)/automake.in | \
147               grep -F -v 'undef $$/'; then \
148           echo "Found undef in automake.in; use delete instead" 1>&2; \
149           exit 1; \
150         fi
151
152 ## We never want split (/ /,...), only split (' ', ...).
153 sc_perl_no_split_regex_space:
154         @if grep -n 'split (/ /' $(srcdir)/automake.in; then \
155           echo "Found bad split in the lines above." 1>&2; \
156           exit 1; \
157         fi
158
159 ## Look for cd within backquotes
160 sc_cd_in_backquotes:
161         @if grep -n '^[^#]*` *cd ' $(srcdir)/automake.in $(ams); then \
162           echo "Consider using \$$(am__cd) in the lines above." 1>&2; \
163           exit 1; \
164         fi
165
166 ## Look for cd to a relative directory (may be influenced by CDPATH).
167 ## Skip some known directories that are OK.
168 sc_cd_relative_dir:
169         @if grep -n '^[^#]*cd ' $(srcdir)/automake.in $(ams) | \
170               grep -v 'echo.*cd ' | \
171               grep -v 'am__cd =' | \
172               grep -v '^[^#]*cd [./]' | \
173               grep -v '^[^#]*cd \$$(top_builddir)' | \
174               grep -v '^[^#]*cd "\$$\$$am__cwd' | \
175               grep -v '^[^#]*cd \$$(abs' | \
176               grep -v '^[^#]*cd "\$$(DESTDIR)'; then \
177           echo "Consider using \$$(am__cd) in the lines above." 1>&2; \
178           exit 1; \
179         fi
180
181 ## Using @_ in a scalar context is most probably a programming error.
182 sc_perl_at_uscore_in_scalar_context:
183         @if grep -Hn '[^@_A-Za-z0-9][_A-Za-z0-9]*[^) ] *= *@_' $(srcdir)/automake.in; then \
184           echo "Using @_ in a scalar context in the lines above." 1>&2; \
185           exit 1; \
186         fi
187
188 ## Allow only few variables to be localized in Automake.
189 sc_perl_local:
190         @if egrep -v '^[ \t]*local \$$[_~]( *=|;)' $(srcdir)/automake.in | \
191                 grep '^[ \t]*local [^*]'; then \
192           echo "Please avoid 'local'." 1>&2; \
193           exit 1; \
194         fi
195
196 ## Don't let AMDEP_TRUE substitution appear in automake.in.
197 sc_AMDEP_TRUE_in_automake_in:
198         @if grep '@AMDEP''_TRUE@' $(srcdir)/automake.in; then \
199           echo "Don't put AMDEP_TRUE substitution in automake.in" 1>&2; \
200           exit 1; \
201         fi
202
203 ## Recursive make invocations should always pass $(AM_MAKEFLAGS)
204 ## to $(MAKE), for portability to non-GNU make.
205 sc_tests_make_without_am_makeflags:
206         @if grep '^[^#].*(MAKE) ' $(ams) $(srcdir)/automake.in \
207             | grep -v 'AM_MAKEFLAGS' \
208             | grep -v '/am/header-vars\.am:.*am--echo.*| $$(MAKE) -f *-'; \
209         then \
210           echo 'Use $$(MAKE) $$(AM_MAKEFLAGS).' 1>&2; \
211           exit 1; \
212         fi
213
214 ## Look out for some obsolete variables.
215 sc_tests_obsolete_variables:
216         @vars=" \
217           using_tap \
218           test_prefer_config_shell \
219           original_AUTOMAKE \
220           original_ACLOCAL \
221           parallel_tests \
222           am_parallel_tests \
223         "; \
224         seen=""; \
225         for v in $$vars; do \
226           if grep -E "\b$$v\b" $(xtests) $(xdefs); then \
227             seen="$$seen $$v"; \
228           fi; \
229         done; \
230         if test -n "$$seen"; then \
231           for v in $$seen; do \
232             case $$v in \
233               parallel_tests|am_parallel_tests) v2=am_serial_tests;; \
234               *) v2=am_$$v;; \
235             esac; \
236             echo "Variable '$$v' is obsolete, use '$$v2' instead." 1>&2; \
237           done; \
238           exit 1; \
239         else :; fi
240
241 ## Look out for obsolete requirements specified in the test cases.
242 sc_obsolete_requirements_rules = sc_no_texi2dvi-o sc_no_makeinfo-html
243 modern-requirement.texi2dvi-o = texi2dvi
244 modern-requirement.makeinfo-html = makeinfo
245
246 $(sc_obsolete_requirements_rules): sc_no_% :
247         @if grep -E 'required=.*\b$*\b' $(xtests); then \
248           echo "Requirement '$*' is obsolete and shouldn't" \
249                "be used anymore." >&2; \
250           echo "You should use '$(modern-requirement.$*)' instead." >&2; \
251           exit 1; \
252         fi
253
254 ## Tests should never call some programs directly, but only through the
255 ## corresponding variable (e.g., '$MAKE', not 'make').  This will allow
256 ## the programs to be overridden at configure time (for less brittleness)
257 ## or by the user at make time (to allow better testsuite coverage).
258 sc_tests_plain_check_rules = \
259   sc_tests_plain_egrep \
260   sc_tests_plain_fgrep \
261   sc_tests_plain_make \
262   sc_tests_plain_perl \
263   sc_tests_plain_automake \
264   sc_tests_plain_aclocal \
265   sc_tests_plain_autoconf \
266   sc_tests_plain_autoupdate \
267   sc_tests_plain_autom4te \
268   sc_tests_plain_autoheader \
269   sc_tests_plain_autoreconf
270
271 toupper = $(shell echo $(1) | LC_ALL=C tr '[a-z]' '[A-Z]')
272
273 $(sc_tests_plain_check_rules): sc_tests_plain_% :
274         @# The leading ':' in the grep below is what is printed by the
275         @# preceding 'grep -v' after the file name.
276         @# It works here as a poor man's substitute for beginning-of-line
277         @# marker.
278         @if grep -v '^[         ]*#' $(xtests) \
279            | $(EGREP) '(:|\bif|\bnot|[;!{\|\(]|&&|\|\|)[        ]*?$*\b'; \
280          then \
281            echo 'Do not run "$*" in the above tests.' \
282                 'Use "$$$(call toupper,$*)" instead.' 1>&2; \
283            exit 1; \
284         fi
285
286 ## Tests should only use END and EOF for here documents
287 ## (so that the next test is effective).
288 sc_tests_here_document_format:
289         @if grep '<<' $(xtests) | grep -Ev '\b(END|EOF)\b|\bcout <<'; then \
290           echo 'Use here documents with "END" and "EOF" only, for greppability.' 1>&2; \
291           exit 1; \
292         fi
293
294 ## Tests should never call exit directly, but use Exit.
295 ## This is so that the exit status is transported correctly across the 0 trap.
296 ## Ignore comments and our testsuite's own self tests.
297 sc_tests_Exit_not_exit:
298         @found=false; for file in $(xtests); do \
299           case $$file in */self-check-*) continue;; esac; \
300           res=`sed -n -e '/^#/d' -e '/<<.*END/,/^END/b' -e '/<<.*EOF/,/^EOF/b' \
301                       -e '/exit [$$0-9]/p' $$file`; \
302           if test -n "$$res"; then \
303             echo "$$file:$$res"; \
304             found=true; \
305           fi; \
306         done; \
307         if $$found; then \
308           echo 'Do not call plain "exit", use "Exit" instead, in above tests.' 1>&2; \
309           exit 1; \
310         fi
311
312 ## Use AUTOMAKE_fails when appropriate
313 sc_tests_automake_fails:
314         @if grep -v '^#' $(xtests) | grep '\$$AUTOMAKE.*&&.*[eE]xit'; then \
315           echo 'Use AUTOMAKE_fails + grep to catch automake failures in the above tests.' 1>&2;  \
316           exit 1; \
317         fi
318
319 ## Setting 'required' after sourcing './defs' is a bug.
320 sc_tests_required_after_defs:
321         @for file in $(xtests); do \
322           if out=`sed -n '/defs/,$${/required=/p;}' $$file`; test -n "$$out"; then \
323             echo 'Do not set "required" after sourcing "defs" in '"$$file: $$out" 1>&2; \
324             exit 1; \
325           fi; \
326         done
327
328 ## Overriding a Makefile macro on the command line is not portable when
329 ## recursive targets are used.  Better use an envvar.  SHELL is an
330 ## exception, POSIX says it can't come from the environment.  V, DESTDIR,
331 ## DISTCHECK_CONFIGURE_FLAGS and DISABLE_HARD_ERRORS are exceptions, too,
332 ## as package authors are urged not to initialize them anywhere.
333 ## Finally, 'exp' is used by some ad-hoc checks, where we ensure it's
334 ## ok to override it from the command line.
335 sc_tests_overriding_macros_on_cmdline:
336         @if grep -E '\$$MAKE .*(SHELL=.*=|=.*SHELL=)' $(xtests); then \
337           echo 'Rewrite "$$MAKE foo=bar SHELL=$$SHELL" as "foo=bar $$MAKE -e SHELL=$$SHELL"' 1>&2; \
338           echo ' in the above lines, it is more portable.' 1>&2; \
339           exit 1; \
340         fi
341 # The first s/// tries to account for usages like "$MAKE || st=$?".
342 # 'DISTCHECK_CONFIGURE_FLAGS' and 'exp' are allowed to contain whitespace in
343 # their definitions, hence the more complex last three substitutions below.
344 # Also, the 'make-dryrun.sh' is whitelisted, since there we need to
345 # override variables from the command line in order to cover the expected
346 # code paths.
347         @tests=`for t in $(xtests); do \
348                   case $$t in */make-dryrun.sh);; *) echo $$t;; esac; \
349                 done`; \
350         if sed -e 's/ || .*//' -e 's/ && .*//' \
351                 -e 's/ DESTDIR=[^ ]*/ /' -e 's/ SHELL=[^ ]*/ /' \
352                 -e 's/ V=[^ ]*/ /' -e 's/ DISABLE_HARD_ERRORS=[^ ]*/ /' \
353                 -e "s/ DISTCHECK_CONFIGURE_FLAGS='[^']*'/ /" \
354                 -e 's/ DISTCHECK_CONFIGURE_FLAGS="[^"]*"/ /' \
355                 -e 's/ DISTCHECK_CONFIGURE_FLAGS=[^ ]/ /' \
356                 -e "s/ exp='[^']*'/ /" \
357                 -e 's/ exp="[^"]*"/ /' \
358                 -e 's/ exp=[^ ]/ /' \
359               $$tests | grep '\$$MAKE .*='; then \
360           echo 'Rewrite "$$MAKE foo=bar" as "foo=bar $$MAKE -e" in the above lines,' 1>&2; \
361           echo 'it is more portable.' 1>&2; \
362           exit 1; \
363         fi
364         @if grep 'SHELL=.*\$$MAKE' $(xtests); then \
365           echo '$$MAKE ignores the SHELL envvar, use "$$MAKE SHELL=$$SHELL" in' 1>&2; \
366           echo 'the above lines.' 1>&2; \
367           exit 1; \
368         fi
369
370 ## Prefer use of our 'is_newest' auxiliary script over the more hacky
371 ## idiom "test $(ls -1t new old | sed 1q) = new", which is both more
372 ## cumbersome and more fragile.
373 sc_tests_ls_t:
374         @if LC_ALL=C grep -E '\bls(\s+-[a-zA-Z0-9]+)*\s+-[a-zA-Z0-9]*t' \
375             $(xtests); then \
376           echo "Use 'is_newest' rather than hacks based on 'ls -t'" 1>&2; \
377           exit 1; \
378         fi
379
380 ## Never use 'sleep 1' to create files with different timestamps.
381 ## Use '$sleep' instead.  Some filesystems (e.g., Windows) have only
382 ## a 2sec resolution.
383 sc_tests_plain_sleep:
384         @if grep -E '\bsleep +[12345]\b' $(xtests); then \
385           echo 'Do not use "sleep x" in the above tests.  Use "$$sleep" instead.' 1>&2; \
386           exit 1; \
387         fi
388
389 ## fgrep and egrep are not required by POSIX.
390 sc_m4_am_plain_egrep_fgrep:
391         @if grep -E '\b[ef]grep\b' $(ams) $(srcdir)/m4/*.m4; then \
392           echo 'Do not use egrep or fgrep in the above files,' \
393                'they are not portable.' 1>&2; \
394           exit 1; \
395         fi
396
397 ## Prefer 'configure.ac' over the obsolescent 'configure.in' as the name
398 ## for configure input files in our testsuite.  The latter  has been
399 ## deprecated for several years (at least since autoconf 2.50).
400 sc_tests_no_configure_in:
401         @if grep -E '\bconfigure\\*\.in\b' $(xtests) $(xdefs) \
402               | grep -Ev '/backcompat.*\.(sh|tap):' \
403               | grep -Ev '/autodist-configure-no-subdir\.sh:' \
404               | grep -Ev '/(configure|help)\.sh:' \
405               | grep .; \
406         then \
407           echo "Use 'configure.ac', not 'configure.in', as the name" >&2; \
408           echo "for configure input files in the test cases above." >&2; \
409           exit 1; \
410         fi
411
412 ## Rule to ensure that the testsuite has been run before.  We don't depend
413 ## on 'check' here, because that would be very wasteful in the common case.
414 ## We could run "make check RECHECK_LOGS=" and avoid toplevel races with
415 ## AM_RECURSIVE_TARGETS.  Suggest keeping test directories around for
416 ## greppability of the Makefile.in files.
417 sc_ensure_testsuite_has_run:
418         @if test ! -f '$(TEST_SUITE_LOG)'; then \
419           echo 'Run "env keep_testdirs=yes make check" before' \
420                'running "make maintainer-check"' >&2; \
421           exit 1; \
422         fi
423 .PHONY: sc_ensure_testsuite_has_run
424
425 ## Ensure our warning and error messages do not contain duplicate 'warning:' prefixes.
426 ## This test actually depends on the testsuite having been run before.
427 sc_tests_logs_duplicate_prefixes: sc_ensure_testsuite_has_run
428         @if grep -E '(warning|error):.*(warning|error):' t/*.log; then \
429           echo 'Duplicate warning/error message prefixes seen in above tests.' >&2; \
430           exit 1; \
431         fi
432
433 ## Ensure variables are listed before rules in Makefile.in files we generate.
434 sc_tests_makefile_variable_order: sc_ensure_testsuite_has_run
435         @st=0; \
436         for file in `find t -name Makefile.in -print`; do \
437           latevars=`sed -n \
438             -e :x -e 's/#.*//' \
439             -e '/\\\\$$/{' -e N -e 'b x' -e '}' \
440             -e '# Literal TAB.' \
441             -e '1,/^    /d' \
442             -e '# Allow @ so we match conditionals.' \
443             -e '/^ *[a-zA-Z_@]\{1,\} *=/p' $$file`; \
444           if test -n "$$latevars"; then \
445             echo "Variables are expanded too late in $$file:" >&2; \
446             echo "$$latevars" | sed 's/^/  /' >&2; \
447             st=1; \
448           fi; \
449         done; \
450         test $$st -eq 0 || { \
451           echo 'Ensure variables are expanded before rules' >&2; \
452           exit 1; \
453         }
454
455 ## Using ':' as a PATH separator is not portable.
456 sc_tests_PATH_SEPARATOR:
457         @if grep -E '\bPATH=.*:.*' $(xtests) ; then \
458           echo "Use '\$$PATH_SEPARATOR', not ':', in PATH definitions" \
459                "above." 1>&2; \
460           exit 1; \
461         fi
462
463 ## Try to make sure all @...@ substitutions are covered by our
464 ## substitution rule.
465 sc_perl_at_substs:
466         @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' aclocal | wc -l` -ne 0; then \
467           echo "Unresolved @...@ substitution in aclocal" 1>&2; \
468           exit 1; \
469         fi
470         @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' automake | wc -l` -ne 0; then \
471           echo "Unresolved @...@ substitution in automake" 1>&2; \
472           exit 1; \
473         fi
474
475 sc_unquoted_DESTDIR:
476         @if grep -E "[^\'\"]\\\$$\(DESTDIR" $(ams); then \
477           echo 'Suspicious unquoted DESTDIR uses.' 1>&2 ; \
478           exit 1; \
479         fi
480
481 sc_tabs_in_texi:
482         @if grep '      ' $(srcdir)/doc/automake.texi; then \
483           echo 'Do not use tabs in the manual.' 1>&2; \
484           exit 1; \
485         fi
486
487 sc_at_in_texi:
488         @if grep -E '([^@]|^)@([         ][^@]|$$)' $(srcdir)/doc/automake.texi; \
489         then \
490           echo 'Unescaped @.' 1>&2; \
491           exit 1; \
492         fi
493
494 $(syntax_check_rules): automake aclocal
495 maintainer-check: $(syntax_check_rules)
496 .PHONY: maintainer-check $(syntax_check_rules)
497
498 ## Check that the list of tests given in the Makefile is equal to the
499 ## list of all test scripts in the Automake testsuite.
500 maintainer-check: maintainer-check-list-of-tests