From: Stefano Lattarini Date: Sat, 25 May 2013 20:22:55 +0000 (+0200) Subject: lint: cosmetics: use #-comments, not ##-comments X-Git-Tag: v1.13.2b~28 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=372d0c09051d0de402a0e1add4e6734c1a578919;p=thirdparty%2Fautomake.git lint: cosmetics: use #-comments, not ##-comments * syntax-checks.mk: Here. This makes sense because this file is not meant to be processed by Automake, so the ##-comments are not treated specially. Signed-off-by: Stefano Lattarini --- diff --git a/syntax-checks.mk b/syntax-checks.mk index bacb903fa..ef05d06ad 100644 --- a/syntax-checks.mk +++ b/syntax-checks.mk @@ -103,10 +103,10 @@ sc_sanity_gnu_grep: .PHONY: sc_sanity_gnu_grep $(syntax_check_rules): sc_sanity_gnu_grep -## These check avoids accidental configure substitutions in the source. -## 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. +# These check avoids accidental configure substitutions in the source. +# 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_% : @@ -124,15 +124,15 @@ sc_diff_automake sc_diff_aclocal: sc_diff_% : } >&1; \ rm -f $$tmp -## Expect no instances of '${...}'. However, $${...} is ok, since that -## is a shell construct, not a Makefile construct. +# 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; \ else :; fi -## Make sure 'rm' is called with '-f'. +# Make sure 'rm' is called with '-f'. sc_rm_minus_f: @if grep -v '^#' $(ams) $(xtests) \ | grep -vE '/(spy-rm\.tap|subobj-clean.*-pr10697\.sh):' \ @@ -142,16 +142,16 @@ sc_rm_minus_f: exit 1; \ else :; fi -## Never use something like "for file in $(FILES)", this doesn't work -## if FILES is empty or if it contains shell meta characters (e.g. $ is -## commonly used in Java filenames). +# Never use something like "for file in $(FILES)", this doesn't work +# if FILES is empty or if it contains shell meta characters (e.g. $ is +# commonly used in Java filenames). sc_no_for_variable_in_macro: @if grep 'for .* in \$$(' $(ams) | grep -v '/Makefile\.am:'; then \ echo 'Use "list=$$(mumble); for var in $$$$list".' 1>&2 ; \ exit 1; \ else :; fi -## Make sure all invocations of mkinstalldirs are correct. +# Make sure all invocations of mkinstalldirs are correct. sc_mkinstalldirs: @if grep -n 'mkinstalldirs' $(ams) \ | grep -F -v '$$(mkinstalldirs)' \ @@ -161,7 +161,7 @@ sc_mkinstalldirs: exit 1; \ else :; fi -## Make sure all calls to PRE/NORMAL/POST_INSTALL/UNINSTALL +# Make sure all calls to PRE/NORMAL/POST_INSTALL/UNINSTALL sc_pre_normal_post_install_uninstall: @if grep -E -n '\((PRE|NORMAL|POST)_(|UN)INSTALL\)' $(ams) | \ grep -v ':##' | grep -v ': @\$$('; then \ @@ -169,7 +169,7 @@ sc_pre_normal_post_install_uninstall: exit 1; \ else :; fi -## We never want to use "undef", only "delete", but for $/. +# We never want to use "undef", only "delete", but for $/. sc_perl_no_undef: @if grep -n -w 'undef ' $(srcdir)/automake.in | \ grep -F -v 'undef $$/'; then \ @@ -177,22 +177,22 @@ sc_perl_no_undef: exit 1; \ fi -## We never want split (/ /,...), only split (' ', ...). +# We never want split (/ /,...), only split (' ', ...). sc_perl_no_split_regex_space: @if grep -n 'split (/ /' $(srcdir)/automake.in; then \ echo "Found bad split in the lines above." 1>&2; \ exit 1; \ fi -## Look for cd within backquotes +# Look for cd within backquotes sc_cd_in_backquotes: @if grep -n '^[^#]*` *cd ' $(srcdir)/automake.in $(ams); then \ echo "Consider using \$$(am__cd) in the lines above." 1>&2; \ exit 1; \ fi -## Look for cd to a relative directory (may be influenced by CDPATH). -## Skip some known directories that are OK. +# Look for cd to a relative directory (may be influenced by CDPATH). +# Skip some known directories that are OK. sc_cd_relative_dir: @if grep -n '^[^#]*cd ' $(srcdir)/automake.in $(ams) | \ grep -v 'echo.*cd ' | \ @@ -206,14 +206,14 @@ sc_cd_relative_dir: exit 1; \ fi -## Using @_ in a scalar context is most probably a programming error. +# Using @_ in a scalar context is most probably a programming error. sc_perl_at_uscore_in_scalar_context: @if grep -Hn '[^@_A-Za-z0-9][_A-Za-z0-9]*[^) ] *= *@_' $(srcdir)/automake.in; then \ echo "Using @_ in a scalar context in the lines above." 1>&2; \ exit 1; \ fi -## Allow only few variables to be localized in Automake. +# Allow only few variables to be localized in Automake. sc_perl_local: @if egrep -v '^[ \t]*local \$$[_~]( *=|;)' $(srcdir)/automake.in | \ grep '^[ \t]*local [^*]'; then \ @@ -221,15 +221,15 @@ sc_perl_local: exit 1; \ fi -## Don't let AMDEP_TRUE substitution appear in automake.in. +# Don't let AMDEP_TRUE substitution appear in automake.in. sc_AMDEP_TRUE_in_automake_in: @if grep '@AMDEP''_TRUE@' $(srcdir)/automake.in; then \ echo "Don't put AMDEP_TRUE substitution in automake.in" 1>&2; \ exit 1; \ fi -## Recursive make invocations should always pass $(AM_MAKEFLAGS) -## to $(MAKE), for portability to non-GNU make. +# Recursive make invocations should always pass $(AM_MAKEFLAGS) +# to $(MAKE), for portability to non-GNU make. sc_make_without_am_makeflags: @if grep '^[^#].*(MAKE) ' $(ams) $(srcdir)/automake.in \ | grep -Fv '$$(AM_MAKEFLAGS)'; \ @@ -238,7 +238,7 @@ sc_make_without_am_makeflags: exit 1; \ fi -## Look out for some obsolete variables. +# Look out for some obsolete variables. sc_tests_obsolete_variables: @vars=" \ using_tap \ @@ -266,7 +266,7 @@ sc_tests_obsolete_variables: exit 1; \ else :; fi -## Look out for obsolete requirements specified in the test cases. +# 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 @@ -279,10 +279,10 @@ $(sc_obsolete_requirements_rules): sc_no_% : 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) -## or by the user at make time (to allow better testsuite coverage). +# 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) +# or by the user at make time (to allow better testsuite coverage). sc_tests_plain_check_rules = \ sc_tests_plain_egrep \ sc_tests_plain_fgrep \ @@ -311,20 +311,20 @@ $(sc_tests_plain_check_rules): sc_tests_plain_% : exit 1; \ fi -## Tests should only use END and EOF for here documents -## (so that the next test is effective). +# Tests should only use END and EOF for here documents +# (so that the next test is effective). sc_tests_here_document_format: @if grep '<<' $(xtests) | grep -Ev '\b(END|EOF)\b|\bcout <<'; then \ echo 'Use here documents with "END" and "EOF" only, for greppability.' 1>&2; \ exit 1; \ fi -## 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. +# 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 () { \ @@ -346,24 +346,24 @@ sc_tests_command_subst: 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. +# 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. +# 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 -## Invocation of 'run_make' should not have output redirections. +# Invocation of 'run_make' should not have output redirections. sc_tests_no_run_make_redirect: @if grep -Pzo '.*(\$$MAKE|\brun_make)\b(.*(\\\n))*.*>.*' $(xtests); \ then \ @@ -373,7 +373,7 @@ sc_tests_no_run_make_redirect: exit 1; \ fi -## Use AUTOMAKE_fails when appropriate +# Use AUTOMAKE_fails when appropriate sc_tests_automake_fails: @if grep -v '^#' $(xtests) | grep '\$$AUTOMAKE.*&&.*exit'; then \ echo 'Use AUTOMAKE_fails + grep to catch automake failures in the above tests.' 1>&2; \ @@ -391,13 +391,13 @@ sc_tests_no_make_e: exit 1; \ fi -## Overriding a Makefile macro on the command line is not portable when -## recursive targets are used. Better use an envvar. SHELL is an -## exception, POSIX says it can't come from the environment. V, DESTDIR, -## DISTCHECK_CONFIGURE_FLAGS and DISABLE_HARD_ERRORS are exceptions, too, -## as package authors are urged not to initialize them anywhere. -## Finally, 'exp' is used by some ad-hoc checks, where we ensure it's -## ok to override it from the command line. +# Overriding a Makefile macro on the command line is not portable when +# recursive targets are used. Better use an envvar. SHELL is an +# exception, POSIX says it can't come from the environment. V, DESTDIR, +# DISTCHECK_CONFIGURE_FLAGS and DISABLE_HARD_ERRORS are exceptions, too, +# as package authors are urged not to initialize them anywhere. +# Finally, 'exp' is used by some ad-hoc checks, where we ensure it's +# ok to override it from the command line. 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 @@ -423,9 +423,9 @@ sc_tests_overriding_macros_on_cmdline: exit 1; \ fi >&2 -## 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. +# 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 \ @@ -433,16 +433,16 @@ sc_tests_ls_t: exit 1; \ fi -## Never use 'sleep 1' to create files with different timestamps. -## Use '$sleep' instead. Some file systems (e.g., Windows) have only -## a 2sec resolution. +# Never use 'sleep 1' to create files with different timestamps. +# Use '$sleep' instead. Some file systems (e.g., Windows) have only +# a 2sec resolution. sc_tests_plain_sleep: @if grep -E '\bsleep +[12345]\b' $(xtests); then \ echo 'Do not use "sleep x" in the above tests. Use "$$sleep" instead.' 1>&2; \ exit 1; \ fi -## fgrep and egrep are not required by POSIX. +# fgrep and egrep are not required by POSIX. sc_m4_am_plain_egrep_fgrep: @if grep -E '\b[ef]grep\b' $(ams) $(srcdir)/m4/*.m4; then \ echo 'Do not use egrep or fgrep in the above files,' \ @@ -450,9 +450,9 @@ sc_m4_am_plain_egrep_fgrep: exit 1; \ fi -## Prefer 'configure.ac' over the obsolescent 'configure.in' as the name -## for configure input files in our testsuite. The latter has been -## deprecated for several years (at least since autoconf 2.50). +# Prefer 'configure.ac' over the obsolescent 'configure.in' as the name +# for configure input files in our testsuite. The latter has been +# deprecated for several years (at least since autoconf 2.50). sc_tests_no_configure_in: @if grep -E '\bconfigure\\*\.in\b' $(xtests) $(xdefs) \ | grep -Ev '/backcompat.*\.(sh|tap):' \ @@ -465,11 +465,11 @@ sc_tests_no_configure_in: exit 1; \ fi -## Rule to ensure that the testsuite has been run before. We don't depend -## on 'check' here, because that would be very wasteful in the common case. -## We could run "make check RECHECK_LOGS=" and avoid toplevel races with -## AM_RECURSIVE_TARGETS. Suggest keeping test directories around for -## greppability of the Makefile.in files. +# Rule to ensure that the testsuite has been run before. We don't depend +# on 'check' here, because that would be very wasteful in the common case. +# We could run "make check RECHECK_LOGS=" and avoid toplevel races with +# AM_RECURSIVE_TARGETS. Suggest keeping test directories around for +# greppability of the Makefile.in files. sc_ensure_testsuite_has_run: @if test ! -f '$(TEST_SUITE_LOG)'; then \ echo 'Run "env keep_testdirs=yes make check" before' \ @@ -478,15 +478,15 @@ sc_ensure_testsuite_has_run: fi .PHONY: sc_ensure_testsuite_has_run -## Ensure our warning and error messages do not contain duplicate 'warning:' prefixes. -## This test actually depends on the testsuite having been run before. +# Ensure our warning and error messages do not contain duplicate 'warning:' prefixes. +# This test actually depends on the testsuite having been run before. sc_tests_logs_duplicate_prefixes: sc_ensure_testsuite_has_run @if grep -E '(warning|error):.*(warning|error):' t/*.log; then \ echo 'Duplicate warning/error message prefixes seen in above tests.' >&2; \ exit 1; \ fi -## Ensure variables are listed before rules in Makefile.in files we generate. +# Ensure variables are listed before rules in Makefile.in files we generate. sc_tests_makefile_variable_order: sc_ensure_testsuite_has_run @st=0; \ for file in `find t -name Makefile.in -print`; do \ @@ -508,7 +508,7 @@ sc_tests_makefile_variable_order: sc_ensure_testsuite_has_run exit 1; \ } -## Using ':' as a PATH separator is not portable. +# Using ':' as a PATH separator is not portable. sc_tests_PATH_SEPARATOR: @if grep -E '\bPATH=.*:.*' $(xtests) ; then \ echo "Use '\$$PATH_SEPARATOR', not ':', in PATH definitions" \ @@ -516,8 +516,8 @@ sc_tests_PATH_SEPARATOR: exit 1; \ fi -## Try to make sure all @...@ substitutions are covered by our -## substitution rule. +# Try to make sure all @...@ substitutions are covered by our +# substitution rule. sc_perl_at_substs: @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' aclocal | wc -l` -ne 0; then \ echo "Unresolved @...@ substitution in aclocal" 1>&2; \