X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=syntax-checks.mk;h=8f9d8b4c28564f193513cb7cadd47daddf54f584;hb=eddba1ccc124aaed5a613260b259f73e2aedf825;hp=235961295aee94efcaec9efdd293e67f8d9ff135;hpb=c8d13b6142410d2641a13f1f4a38293b1b26cd05;p=platform%2Fupstream%2Fautomake.git diff --git a/syntax-checks.mk b/syntax-checks.mk index 2359612..8f9d8b4 100644 --- a/syntax-checks.mk +++ b/syntax-checks.mk @@ -1,6 +1,6 @@ # Maintainer checks for Automake. Requires GNU make. -# Copyright (C) 2012 Free Software Foundation, Inc. +# 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 @@ -27,11 +27,14 @@ xtests := $(shell \ fi; \ for d in $$dirs; do \ for s in tap sh; do \ - ls $$d/t/*.$$s $$d/t/ax/*.$$s 2>/dev/null; \ + ls $$d/t/ax/*.$$s $$d/t/*.$$s $$d/contrib/t/*.$$s 2>/dev/null; \ done; \ done | sort) -xdefs = $(srcdir)/defs $(srcdir)/defs-static.in +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) @@ -39,9 +42,8 @@ ams := $(shell find $(srcdir) -name '*.dir' -prune -o -name '*.am' -print) # guaranteed to work on my machine. syntax_check_rules = \ $(sc_tests_plain_check_rules) \ -sc_diff_automake_in_automake \ -sc_diff_aclocal_in_automake \ -sc_perl_syntax \ +sc_diff_automake \ +sc_diff_aclocal \ sc_no_brace_variable_expansions \ sc_rm_minus_f \ sc_no_for_variable_in_macro \ @@ -55,13 +57,18 @@ 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_Exit_not_exit \ +sc_tests_command_subst \ +sc_tests_exit_not_Exit \ sc_tests_automake_fails \ sc_tests_required_after_defs \ sc_tests_overriding_macros_on_cmdline \ sc_tests_plain_sleep \ +sc_tests_ls_t \ +sc_tests_executable \ sc_m4_am_plain_egrep_fgrep \ sc_tests_no_configure_in \ sc_tests_PATH_SEPARATOR \ @@ -73,43 +80,42 @@ sc_tabs_in_texi \ sc_at_in_texi ## These check avoids accidental configure substitutions in the source. -## There are exactly 9 lines that should be modified from automake.in to -## automake, and 10 lines that should be modified from aclocal.in to -## aclocal; these wors out to 32 and 34 lines of diffs, respectively. -sc_diff_automake_in_automake: - @if test `diff $(srcdir)/automake.in automake | wc -l` -ne 32; then \ - echo "found too many diffs between automake.in and automake" 1>&2; \ - diff -c $(srcdir)/automake.in automake; \ - exit 1; \ - fi -sc_diff_aclocal_in_aclocal: - @if test `diff $(srcdir)/aclocal.in aclocal | wc -l` -ne 34; then \ - echo "found too many diffs between aclocal.in and aclocal" 1>&2; \ - diff -c $(srcdir)/aclocal.in aclocal; \ - exit 1; \ - fi - -## Syntax check with default Perl (on my machine, Perl 5). -sc_perl_syntax: - @perllibdir="./lib$(PATH_SEPARATOR)$(srcdir)/lib" $(PERL) -c -w automake - @perllibdir="./lib$(PATH_SEPARATOR)$(srcdir)/lib" $(PERL) -c -w aclocal +## 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: sc_diff_% : + @set +e; tmp=$*-diffs.tmp; \ + diff -u $(srcdir)/$*.in $* > $$tmp; test $$? -eq 1 || exit 1; \ + added=`grep -v '^+++ ' $$tmp | grep -c '^+'` || exit 1; \ + removed=`grep -v '^--- ' $$tmp | grep -c '^-'` || exit 1; \ + test $$added,$$removed = $($*_diff_no),$($*_diff_no) \ + || { \ + echo "Found unexpected diffs between $*.in and $*"; \ + echo "Lines added: $$added" ; \ + echo "Lines removed: $$removed"; \ + cat $$tmp >&2; \ + exit 1; \ + } >&1; \ + rm -f $$tmp ## 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; \ + exit 1; \ else :; fi ## Make sure 'rm' is called with '-f'. sc_rm_minus_f: @if grep -v '^#' $(ams) $(xtests) \ - | grep -v '/spy-rm\.tap:' \ + | grep -vE '/(spy-rm\.tap|subobj-clean.*-pr10697\.sh):' \ | grep -E '\)'; \ then \ echo "Suspicious 'rm' invocation." 1>&2; \ - exit 1; \ + exit 1; \ else :; fi ## Never use something like "for file in $(FILES)", this doesn't work @@ -213,6 +219,7 @@ sc_tests_make_without_am_makeflags: sc_tests_obsolete_variables: @vars=" \ using_tap \ + am_using_tap \ test_prefer_config_shell \ original_AUTOMAKE \ original_ACLOCAL \ @@ -236,6 +243,19 @@ sc_tests_obsolete_variables: 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) @@ -276,27 +296,53 @@ sc_tests_here_document_format: exit 1; \ fi -## Tests should never call exit directly, but use Exit. -## This is so that the exit status is transported correctly across the 0 trap. -## Ignore comments and our testsuite's own self tests. -sc_tests_Exit_not_exit: - @found=false; for file in $(xtests); do \ - case $$file in */self-check-*) continue;; esac; \ - res=`sed -n -e '/^#/d' -e '/<<.*END/,/^END/b' -e '/<<.*EOF/,/^EOF/b' \ - -e '/exit [$$0-9]/p' $$file`; \ +## 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 'Do not call plain "exit", use "Exit" instead, in above tests.' 1>&2; \ + 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 ## Use AUTOMAKE_fails when appropriate sc_tests_automake_fails: - @if grep -v '^#' $(xtests) | grep '\$$AUTOMAKE.*&&.*[eE]xit'; then \ + @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 @@ -326,22 +372,16 @@ 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. -# Also, the 'make-dryrun.sh' is whitelisted, since there we need to -# override variables from the command line in order to cover the expected -# code paths. - @tests=`for t in $(xtests); do \ - case $$t in */make-dryrun.sh);; *) echo $$t;; esac; \ - done`; \ - if sed -e 's/ || .*//' -e 's/ && .*//' \ + @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/ DISTCHECK_CONFIGURE_FLAGS="[^"]*"/ /' \ + -e 's/ DISTCHECK_CONFIGURE_FLAGS=[^ ]/ /' \ -e "s/ exp='[^']*'/ /" \ - -e 's/ exp="[^"]*"/ /' \ - -e 's/ exp=[^ ]/ /' \ - $$tests | grep '\$$MAKE .*='; then \ + -e 's/ exp="[^"]*"/ /' \ + -e 's/ exp=[^ ]/ /' \ + $(xtests) | grep '\$$MAKE .*='; then \ echo 'Rewrite "$$MAKE foo=bar" as "foo=bar $$MAKE -e" in the above lines,' 1>&2; \ echo 'it is more portable.' 1>&2; \ exit 1; \ @@ -352,6 +392,29 @@ sc_tests_overriding_macros_on_cmdline: exit 1; \ fi +## 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 + +## Test scripts must be executable. +sc_tests_executable: + @st=0; \ + for f in $(xtests); do \ + case $$f in \ + t/ax/*|./t/ax/*|$(srcdir)/t/ax/*);; \ + *) test -x $$f || { echo "$$f: not executable" >&2; st=1; }; \ + esac; \ + done; \ + test $$st -eq 0 || echo '$@: some test scripts are not executable' >&2; \ + exit $$st; + + ## Never use 'sleep 1' to create files with different timestamps. ## Use '$sleep' instead. Some filesystems (e.g., Windows) have only ## a 2sec resolution.