> I suggest to use the following solution that works properly in all
> cases while avoiding the code duplication (in the spirit of
> _prohibit_regexp):
Good idea.
I heavily expanded the _prohibit_regexp macro to accept more arguments
and renamed it to _sc_search_regexp. Using the new parameters it is
possible to write rules like:
# Ensure that each .c file containing a "main" function also
# calls set_program_name.
sc_program_name:
@require='set_program_name *\(m?argv\[0\]\);' \
in_files='\.c$$' \
containing='^main *(' \
msg='the above files do not call set_program_name' \
$(_sc_search_regexp)
Apart from that, I renamed _header_without_use to
_sc_header_without_use and adapted the sc_ rules to use
_sc_search_regexp when possible.
It is possible to expand _sc_search_regexp to cover more existing
rules by introducing new arguments in the same spirit than the
existing ones. Maybe I bloated the poor macro, but I like this
"declarative" style.
>From e0cb7756e086ff9b272173313100b00718b7159e Mon Sep 17 00:00:00 2001
From: Jose E. Marchesi <jema...@malditobastardo.(none)>
Date: Thu, 25 Feb 2010 21:45:20 +0100
Subject: [PATCH] syntax-check: new macro _sc_search_regexp and small fixes in
rules.
---
ChangeLog | 22 ++++
top/maint.mk | 330 ++++++++++++++++++++++++++++++++++-----------------------
2 files changed, 219 insertions(+), 133 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 0c9e14f..541cbb6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,25 @@
+2010-02-25 Jose E. Marchesi <jema...@gnu.org>
+
+ syntax-check: new macro _sc_search_regexp and small fixes in rules.
+ * maint.mk: New macro '_sc_search_regexp'.
+ Macro '_prohibit_regexp' replaced with '_sc_prohibit_regexp' in
+ rules.
+ Macro '_header_without_use' renamed to '_sc_header_without_use' in
+ rules.
+ (sc_useless_cpp_parens): Use a character set for ')' to
+ avoid grep to complain about an unmatched ')'.
+ (sc_require_config_h_first): Avoid calling the file selection grep
+ twice.
+ (sc_program_name): Likewise.
+ (sc_require_config_h): Use '_sc_search_regexp'.
+ (sc_changelog): Likewise.
+ (sc_error_exit_success): Catch function calls with zero or more
+ than one blank character between the function name and the
+ argument list.
+ (sc_error_message_warn_fatal): Likewise.
+ (sc_error_message_uppercase): Likewise.
+ (sc_error_message_period): Likewise.
+
2010-02-25 Bruno Haible <br...@clisp.org>
Fix breakage of gnulib-tool with ksh, introduced on 2010-02-21.
diff --git a/top/maint.mk b/top/maint.mk
index 7d84b6c..c1969ab 100644
--- a/top/maint.mk
+++ b/top/maint.mk
@@ -144,19 +144,102 @@ syntax-check: $(local-check)
# exit 1; } || :
# FIXME: don't allow `#include .strings\.h' anywhere
-# By default, _prohibit_regexp does not ignore case.
+# _sc_search_regexp
+#
+# This macro searches for a given construct in the selected files and
+# then takes some action.
+#
+# Parameters (environment variables):
+#
+# prohibit | require
+#
+# Regular expression denoting either a forbidded construct or a
+# required construct. Those arguments are exclusive.
+#
+# in_files | not_in_files
+#
+# grep-E-style regexp denoting the files to check.
+#
+# containing | non_containing
+#
+# Select the files (non) containing strings matching this regexp.
+# If both arguments are specified then CONTAINING takes
+# precedence.
+#
+# with_grep_options
+#
+# Extra options for grep.
+#
+# ignore_case
+#
+# Ignore case.
+#
+# halt | warn
+#
+# Message to display before to halt the execution.
+
+# By default, _sc_search_regexp does not ignore case.
export ignore_case =
_ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
-# There are many rules below that prohibit constructs in this package.
-# If the offending construct can be matched with a grep-E-style regexp,
-# use this macro. The shell variables "re" and "msg" must be defined.
-define _prohibit_regexp
+define _sc_say_and_exit
+ dummy=; : so we do not need a semicolon before each use;
\
+ { echo "$(ME): $$msg" 1>&2; exit 1; };
+endef
+
+define _sc_search_regexp
+ dummy=; : so we do not need a semicolon before each use;
\
+
\
+ : Check arguments;
\
+ test -n "$$prohibit" -a -n "$$require" &&
\
+ { msg='Cannot specify both prohibit and require' $(_sc_say_and_exit) }
|| :; \
+ test -z "$$prohibit" -a -z "$$require" &&
\
+ { msg='Should specify either prohibit or require' $(_sc_say_and_exit) }
|| :; \
+ test -n "$$in_files" -a -n "$$not_in_files" &&
\
+ { msg='Cannot specify both in-files and not_in_files'
\
+ $(_sc_say_and_exit) } || :;
\
+ test "x$$msg" != x || { msg='msg not defined' $(_sc_say_and_exit) };
\
+
\
+ : Filter by file name;
\
+ if test -n "$$in_files"; then
\
+ files=$$($(VC_LIST_EXCEPT) | grep -E "$$in_files");
\
+ else
\
+ files=$$($(VC_LIST_EXCEPT));
\
+ fi;
\
+
\
+ : Filter by content;
\
+ test -n "$$files" -a -n "$$containing" &&
\
+ { files=$$(grep -l "$$containing" $$files); } || :;
\
+ test -n "$$files" -a -n "$$non_containing" &&
\
+ { files=$$(grep -vl "$$non_containing" $$files); } || :;
\
+
\
+ : Check for the construct;
\
+ if test -n "$$files"; then
\
+ if test -n "$$prohibit"; then
\
+ grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files &&
\
+ { msg="$$msg" $(_sc_say_and_exit) } || :;
\
+ else
\
+ grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files | grep
. && \
+ { msg="$$msg" $(_sc_say_and_exit) } || :;
\
+ fi
\
+ else :;
\
+ fi || :;
+endef
+
+# To use this "command" macro, you must first define two shell variables:
+# h: the header, enclosed in <> or ""
+# re: a regular expression that matches IFF something provided by $h is used.
+define _sc_header_without_use
dummy=; : so we do not need a semicolon before each use; \
- test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; }; \
- test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
- grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) && \
- { echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
+ h_esc=`echo "$$h"|sed 's/\./\\\\./g'`; \
+ if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
+ files=$$(grep -l '^# *include '"$$h_esc" \
+ $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
+ grep -LE "$$re" $$files | grep . &&
\
+ { echo "$(ME): the above files include $$h but don't use it" \
+ 1>&2; exit 1; } || :; \
+ else :; \
+ fi
endef
sc_avoid_if_before_free:
@@ -167,29 +250,31 @@ sc_avoid_if_before_free:
exit 1; } || :
sc_cast_of_argument_to_free:
- @re='\<free *\( *\(' msg='don'\''t cast free argument' \
- $(_prohibit_regexp)
+ @prohibit='\<free *\( *\(' msg='don'\''t cast free argument' \
+ $(_sc_search_regexp)
sc_cast_of_x_alloc_return_value:
- @re='\*\) *x(m|c|re)alloc\>' \
+ @prohibit='\*\) *x(m|c|re)alloc\>' \
msg='don'\''t cast x*alloc return value' \
- $(_prohibit_regexp)
+ $(_sc_search_regexp)
sc_cast_of_alloca_return_value:
- @re='\*\) *alloca\>' msg='don'\''t cast alloca return value' \
- $(_prohibit_regexp)
+ @prohibit='\*\) *alloca\>' \
+ msg='don'\''t cast alloca return value' \
+ $(_sc_search_regexp)
sc_space_tab:
- @re='[ ] ' msg='found SPACE-TAB sequence; remove the SPACE' \
- $(_prohibit_regexp)
+ @prohibit='[ ] ' \
+ msg='found SPACE-TAB sequence; remove the SPACE' \
+ $(_sc_search_regexp)
# Don't use *scanf or the old ato* functions in `real' code.
# They provide no error checking mechanism.
# Instead, use strto* functions.
sc_prohibit_atoi_atof:
- @re='\<([fs]?scanf|ato([filq]|ll)) *\(' \
- msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
- $(_prohibit_regexp)
+ @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\('
\
+ msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q'
\
+ $(_sc_search_regexp)
# Use STREQ rather than comparing strcmp == 0, or != 0.
sc_prohibit_strcmp:
@@ -210,28 +295,29 @@ sc_prohibit_strcmp:
# | xargs --no-run-if-empty \
# perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
sc_prohibit_magic_number_exit:
- @re='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \
+ @prohibit='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,'
\
msg='use EXIT_* values rather than magic number' \
- $(_prohibit_regexp)
+ $(_sc_search_regexp)
# Using EXIT_SUCCESS as the first argument to error is misleading,
# since when that parameter is 0, error does not exit. Use `0' instead.
sc_error_exit_success:
- @grep -nE 'error \(EXIT_SUCCESS,' \
- $$($(VC_LIST_EXCEPT) | grep -E '\.[chly]$$') && \
- { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; exit 1; } || :
+ @prohibit='error *\(EXIT_SUCCESS,' \
+ in_files='\.[chly]$$' \
+ msg='found error (EXIT_SUCCESS' \
+ $(_sc_search_regexp)
# `FATAL:' should be fully upper-cased in error messages
# `WARNING:' should be fully upper-cased, or fully lower-cased
sc_error_message_warn_fatal:
- @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
+ @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
| grep -E '"Warning|"Fatal|"fatal' && \
{ echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
exit 1; } || :
# Error messages should not start with a capital letter
sc_error_message_uppercase:
- @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
+ @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
| grep -E '"[A-Z]' \
| grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
{ echo '$(ME): found capitalized error message' 1>&2; \
@@ -239,42 +325,39 @@ sc_error_message_uppercase:
# Error messages should not end with a period
sc_error_message_period:
- @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
+ @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
| grep -E '[^."]\."' && \
{ echo '$(ME): found error message ending in period' 1>&2; \
exit 1; } || :
sc_file_system:
- @re=file''system ignore_case=1 \
+ @prohibit=file''system ignore_case=1 \
msg='found use of "file''system"; spell it "file system"' \
- $(_prohibit_regexp)
+ $(_sc_search_regexp)
# Don't use cpp tests of this symbol. All code assumes config.h is included.
sc_prohibit_have_config_h:
- @grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) && \
- { echo '$(ME): found use of HAVE''_CONFIG_H; remove' \
- 1>&2; exit 1; } || :
+ @prohibit='^# *if.*HAVE''_CONFIG_H' \
+ msg='found use of HAVE''_CONFIG_H; remove' \
+ $(_sc_search_regexp)
# Nearly all .c files must include <config.h>. However, we also permit this
# via inclusion of a package-specific header, if cfg.mk specified one.
# config_h_header must be suitable for grep -E.
config_h_header ?= <config\.h>
sc_require_config_h:
- @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
- grep -EL '^# *include $(config_h_header)' \
- $$($(VC_LIST_EXCEPT) | grep '\.c$$') \
- | grep . && \
- { echo '$(ME): the above files do not include <config.h>' \
- 1>&2; exit 1; } || :; \
- else :; \
- fi
+ @require='^# *include $(config_h_header)' \
+ in_files='\.c$$' \
+ msg='the above files do not include <config.h>' \
+ $(_sc_search_regexp)
# You must include <config.h> before including any other header file.
# This can possibly be via a package-specific header, if given by cfg.mk.
sc_require_config_h_first:
- @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
+ @files=$$($(VC_LIST_EXCEPT) | grep '\.c$$'); \
+ if test -n "$$files"; then \
fail=0; \
- for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
+ for i in $$files; do \
grep '^# *include\>' $$i | sed 1q \
| grep -E '^# *include $(config_h_header)' > /dev/null \
|| { echo $$i; fail=1; }; \
@@ -286,65 +369,50 @@ sc_require_config_h_first:
fi
sc_prohibit_HAVE_MBRTOWC:
- @re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
- $(_prohibit_regexp)
-
-# To use this "command" macro, you must first define two shell variables:
-# h: the header, enclosed in <> or ""
-# re: a regular expression that matches IFF something provided by $h is used.
-define _header_without_use
- dummy=; : so we do not need a semicolon before each use; \
- h_esc=`echo "$$h"|sed 's/\./\\\\./g'`; \
- if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
- files=$$(grep -l '^# *include '"$$h_esc" \
- $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
- grep -LE "$$re" $$files | grep . &&
\
- { echo "$(ME): the above files include $$h but don't use it" \
- 1>&2; exit 1; } || :; \
- else :; \
- fi
-endef
+ @prohibit='\bHAVE_MBRTOWC\b' \
+ msg="do not use $$prohibit; it is always defined" \
+ $(_sc_search_regexp)
# Prohibit the inclusion of assert.h without an actual use of assert.
sc_prohibit_assert_without_use:
- @h='<assert.h>' re='\<assert *\(' $(_header_without_use)
+ @h='<assert.h>' re='\<assert *\(' $(_sc_header_without_use)
# Prohibit the inclusion of close-stream.h without an actual use.
sc_prohibit_close_stream_without_use:
- @h='"close-stream.h"' re='\<close_stream *\(' $(_header_without_use)
+ @h='"close-stream.h"' re='\<close_stream *\(' $(_sc_header_without_use)
# Prohibit the inclusion of getopt.h without an actual use.
sc_prohibit_getopt_without_use:
- @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
+ @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_sc_header_without_use)
# Don't include quotearg.h unless you use one of its functions.
sc_prohibit_quotearg_without_use:
- @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
+ @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use)
# Don't include quote.h unless you use one of its functions.
sc_prohibit_quote_without_use:
- @h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
+ @h='"quote.h"' re='\<quote(_n)? *\(' $(_sc_header_without_use)
# Don't include this header unless you use one of its functions.
sc_prohibit_long_options_without_use:
@h='"long-options.h"' re='\<parse_long_options *\(' \
- $(_header_without_use)
+ $(_sc_header_without_use)
# Don't include this header unless you use one of its functions.
sc_prohibit_inttostr_without_use:
@h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
- $(_header_without_use)
+ $(_sc_header_without_use)
# Don't include this header unless you use one of its functions.
sc_prohibit_ignore_value_without_use:
@h='"ignore-value.h"' re='\<ignore_(value|ptr) *\(' \
- $(_header_without_use)
+ $(_sc_header_without_use)
# Don't include this header unless you use one of its functions.
sc_prohibit_error_without_use:
@h='"error.h"' \
re='\<error(_at_line|_print_progname|_one_per_line|_message_count)?
*\('\
- $(_header_without_use)
+ $(_sc_header_without_use)
# Don't include xalloc.h unless you use one of its functions.
# Consider these symbols:
@@ -367,7 +435,7 @@ _xa2 = X([CZ]|N?M)ALLOC
sc_prohibit_xalloc_without_use:
@h='"xalloc.h"' \
re='\<($(_xa1)|$(_xa2)) *\('\
- $(_header_without_use)
+ $(_sc_header_without_use)
# Extract function names:
# perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) \(/ and print $1' lib/hash.h
@@ -378,42 +446,42 @@ _hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>
sc_prohibit_hash_without_use:
@h='"hash.h"' \
re='$(_hash_fn)|$(_hash_struct)'\
- $(_header_without_use)
+ $(_sc_header_without_use)
sc_prohibit_hash_pjw_without_use:
@h='"hash-pjw.h"' \
re='\<hash_pjw *\(' \
- $(_header_without_use)
+ $(_sc_header_without_use)
sc_prohibit_safe_read_without_use:
@h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
- $(_header_without_use)
+ $(_sc_header_without_use)
sc_prohibit_argmatch_without_use:
@h='"argmatch.h"' \
re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid)
*\()' \
- $(_header_without_use)
+ $(_sc_header_without_use)
sc_prohibit_canonicalize_without_use:
@h='"canonicalize.h"' \
re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
- $(_header_without_use)
+ $(_sc_header_without_use)
sc_prohibit_root_dev_ino_without_use:
@h='"root-dev-ino.h"' \
re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
- $(_header_without_use)
+ $(_sc_header_without_use)
sc_prohibit_openat_without_use:
@h='"openat.h"' \
re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>'
\
- $(_header_without_use)
+ $(_sc_header_without_use)
# Prohibit the inclusion of c-ctype.h without an actual use.
ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
|isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
sc_prohibit_c_ctype_without_use:
- @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
+ @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\('
$(_sc_header_without_use)
_empty =
_sp = $(_empty) $(_empty)
@@ -450,35 +518,30 @@ _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names)
$(_sig_types_and_consts)))
sc_prohibit_signal_without_use:
@h='<signal.h>' \
re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
- $(_header_without_use)
+ $(_sc_header_without_use)
sc_obsolete_symbols:
- @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
+ @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>'
\
msg='do not use HAVE''_FCNTL_H or O'_NDELAY \
- $(_prohibit_regexp)
+ $(_sc_search_regexp)
# FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
# Each nonempty ChangeLog line must start with a year number, or a TAB.
sc_changelog:
- @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
- grep -n '^[^12 ]' \
- $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') && \
- { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
- exit 1; } || :; \
- fi
+ @prohibit='^[^12 ]'
\
+ in_files='^ChangeLog$$' \
+ msg='found unexpected prefix in a ChangeLog' \
+ $(_sc_search_regexp)
# Ensure that each .c file containing a "main" function also
# calls set_program_name.
sc_program_name:
- @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
- files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
- grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files \
- | grep . && \
- { echo '$(ME): the above files do not call set_program_name' \
- 1>&2; exit 1; } || :; \
- else :; \
- fi
+ @require='set_program_name *\(m?argv\[0\]\);' \
+ in_files='\.c$$' \
+ containing='^main *(' \
+ msg='the above files do not call set_program_name' \
+ $(_sc_search_regexp)
# Require that the final line of each test-lib.sh-using test be this one:
# Exit $fail
@@ -500,25 +563,23 @@ sc_require_test_exit_idiom:
fi
sc_the_the:
- @re='\<the ''the\>' \
+ @prohibit='\<the ''the\>' \
ignore_case=1 msg='found use of "the ''the";' \
- $(_prohibit_regexp)
+ $(_sc_search_regexp)
sc_trailing_blank:
- @re='[ ]$$' \
+ @prohibit='[ ]$$' \
msg='found trailing blank(s)' \
- $(_prohibit_regexp)
+ $(_sc_search_regexp)
# Match lines like the following, but where there is only one space
# between the options and the description:
# -D, --all-repeated[=delimit-method] print all duplicate lines\n
longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
sc_two_space_separator_in_usage:
- @grep -nE '^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
- $$($(VC_LIST_EXCEPT)) && \
- { echo "$(ME): help2man requires at least two spaces between"; \
- echo "$(ME): an option and its description"; \
- 1>&2; exit 1; } || :
+ @prohibit='^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
+ msg='help2man requires at least two spaces between an option and its
description'\
+ $(_sc_search_regexp)
# Look for diagnostics that aren't marked for translation.
# This won't find any for which error's format string is on a separate line.
@@ -532,43 +593,43 @@ sc_unmarked_diagnostics:
# Avoid useless parentheses like those in this example:
# #if defined (SYMBOL) || defined (SYM2)
sc_useless_cpp_parens:
- @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) && \
- { echo '$(ME): found useless parentheses in cpp directive' \
- 1>&2; exit 1; } || :
+ @prohibit='^# *if .*defined *[)]' \
+ msg='found useless parentheses in cpp directive' \
+ $(_sc_search_regexp)
# Require the latest GPL.
sc_GPL_version:
- @re='either ''version [^3]' msg='GPL vN, N!=3' \
- $(_prohibit_regexp)
+ @prohibit='either ''version [^3]' msg='GPL vN, N!=3'
\
+ $(_sc_search_regexp)
# Require the latest GFDL. Two regexp, since some .texi files end up
# line wrapping between 'Free Documentation License,' and 'Version'.
_GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
sc_GFDL_version:
- @re='$(_GFDL_regexp)' msg='GFDL vN, N!=3' \
- $(_prohibit_regexp)
+ @prohibit='$(_GFDL_regexp)' msg='GFDL vN, N!=3' \
+ $(_sc_search_regexp)
cvs_keywords = \
Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
sc_prohibit_cvs_keyword:
- @re='\$$($(cvs_keywords))\$$' \
+ @prohibit='\$$($(cvs_keywords))\$$'
\
msg='do not use CVS keyword expansion' \
- $(_prohibit_regexp)
+ $(_sc_search_regexp)
# Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
# This is a bit of a kludge, since it prevents use of the string
# even in comments, but for now it does the job with no false positives.
sc_prohibit_stat_st_blocks:
- @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS' \
- $(_prohibit_regexp)
+ @prohibit='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS'
\
+ $(_sc_search_regexp)
# Make sure we don't define any S_IS* macros in src/*.c files.
# They're already defined via gnulib's sys/stat.h replacement.
sc_prohibit_S_IS_definition:
- @re='^ *# *define *S_IS' \
+ @prohibit='^ *# *define *S_IS' \
msg='do not define S_IS* macros; include <sys/stat.h>' \
- $(_prohibit_regexp)
+ $(_sc_search_regexp)
# Each program that uses proper_name_utf8 must link with one of the
# ICONV libraries. Otherwise, some ICONV library must appear in LDADD.
@@ -596,9 +657,9 @@ sc_proper_name_utf8_requires_ICONV:
# Warn about "c0nst struct Foo const foo[]",
# but not about "char const *const foo" or "#define const const".
sc_redundant_const:
- @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
+ @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
msg='redundant "const" in declarations' \
- $(_prohibit_regexp)
+ $(_sc_search_regexp)
sc_const_long_option:
@grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
@@ -652,16 +713,16 @@ news-check: NEWS
fi
sc_makefile_TAB_only_indentation:
- @grep -nE '^ [ ]{8}' \
- $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
- && { echo '$(ME): found TAB-8-space indentation' 1>&2; \
- exit 1; } || :
+ @prohibit='^ [ ]{8}' \
+ in_files='akefile|\.mk$$' \
+ msg='found TAB-8-space indentation' \
+ $(_sc_search_regexp)
sc_m4_quote_check:
- @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
- $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$') \
- && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2; \
- exit 1; } || :
+ @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
+ in_files='(^configure\.ac|\.m4)$$' \
+ msg='quote the first arg to AC_DEF*' \
+ $(_sc_search_regexp)
fix_po_file_diag = \
'you have changed the set of files with translatable diagnostics;\n\
@@ -700,9 +761,10 @@ sc_po_check:
# path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
sc_makefile_path_separator_check:
- @grep -nE 'PATH[=].*:' \
- $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
- && { echo $(msg) 1>&2; exit 1; } || :
+ @prohibit 'PATH[=].*:' \
+ in_files='akefile|\.mk$$' \
+ msg=$(msg) \
+ $(_sc_search_regexp)
# Check that `make alpha' will not fail at the end of the process.
writable-files:
@@ -746,8 +808,10 @@ sc_copyright_check:
# tests many undefined macros, and so we can't enable that option.
# So at least preclude common boolean strings as macro values.
sc_Wundef_boolean:
- @grep -Ei '^#define.*(yes|no|true|false)$$' '$(CONFIG_INCLUDE)' && \
- { echo 'Use 0 or 1 for macro values' 1>&2; exit 1; } || :
+ @prohibit='^#define.*(yes|no|true|false)$$' \
+ in_files='$(CONFIG_INCLUDE)' \
+ msg='Use 0 or 1 for macro values' \
+ $(_sc_search_regexp)
sc_vulnerable_makefile_CVE-2009-4029:
@files=$$(find $(srcdir) -name Makefile.in); \
--
1.6.5
