top/maint.mk

   1 # -*-Makefile-*-
   2 # This Makefile fragment tries to be general-purpose enough to be
   3 # used by many projects via the gnulib maintainer-makefile module.
   4
   5 ## Copyright (C) 2001-2011 Free Software Foundation, Inc.
   6 ##
   7 ## This program is free software: you can redistribute it and/or modify
   8 ## it under the terms of the GNU General Public License as published by
   9 ## the Free Software Foundation, either version 3 of the License, or
  10 ## (at your option) any later version.
  11 ##
  12 ## This program is distributed in the hope that it will be useful,
  13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ## GNU General Public License for more details.
  16 ##
  17 ## You should have received a copy of the GNU General Public License
  18 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 # This is reported not to work with make-3.79.1
  21 # ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
  22 ME := maint.mk
  23
  24 # Override this in cfg.mk if you use a non-standard build-aux directory.
  25 build_aux ?= $(srcdir)/build-aux
  26
  27 # Do not save the original name or timestamp in the .tar.gz file.
  28 # Use --rsyncable if available.
  29 gzip_rsyncable := \
  30   $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null \
  31     && printf %s --rsyncable)
  32 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
  33
  34 GIT = git
  35 VC = $(GIT)
  36
  37 VC_LIST = $(build_aux)/vc-list-files -C $(srcdir)
  38
  39 # You can override this variable in cfg.mk to set your own regexp
  40 # matching files to ignore.
  41 VC_LIST_ALWAYS_EXCLUDE_REGEX ?= ^$$
  42
  43 # This is to preprocess robustly the output of $(VC_LIST), so that even
  44 # when $(srcdir) is a pathological name like "....", the leading sed command
  45 # removes only the intended prefix.
  46 _dot_escaped_srcdir = $(subst .,\.,$(srcdir))
  47
  48 # Post-process $(VC_LIST) output, prepending $(srcdir)/, but only
  49 # when $(srcdir) is not ".".
  50 ifeq ($(srcdir),.)
  51 _prepend_srcdir_prefix =
  52 else
  53 _prepend_srcdir_prefix = | sed 's|^|$(srcdir)/|'
  54 endif
  55
  56 # In order to be able to consistently filter "."-relative names,
  57 # (i.e., with no $(srcdir) prefix), this definition is careful to
  58 # remove any $(srcdir) prefix, and to restore what it removes.
  59 _sc_excl = \
  60   $(if $(exclude_file_name_regexp--$@),$(exclude_file_name_regexp--$@),^$$)
  61 VC_LIST_EXCEPT = \
  62   $(VC_LIST) | sed 's|^$(_dot_escaped_srcdir)/||' \
  63         | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
  64           else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \
  65         | grep -Ev -e '($(VC_LIST_ALWAYS_EXCLUDE_REGEX)|$(_sc_excl))' \
  66         $(_prepend_srcdir_prefix)
  67
  68 ifeq ($(origin prev_version_file), undefined)
  69   prev_version_file = $(srcdir)/.prev-version
  70 endif
  71
  72 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
  73 VERSION_REGEXP = $(subst .,\.,$(VERSION))
  74 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
  75
  76 ifeq ($(VC),$(GIT))
  77 this-vc-tag = v$(VERSION)
  78 this-vc-tag-regexp = v$(VERSION_REGEXP)
  79 else
  80 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
  81 tag-this-version = $(subst .,_,$(VERSION))
  82 this-vc-tag = $(tag-package)-$(tag-this-version)
  83 this-vc-tag-regexp = $(this-vc-tag)
  84 endif
  85 my_distdir = $(PACKAGE)-$(VERSION)
  86
  87 # Old releases are stored here.
  88 release_archive_dir ?= ../release
  89
  90 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.
  91 # Use alpha.gnu.org for alpha and beta releases.
  92 # Use ftp.gnu.org for stable releases.
  93 gnu_ftp_host-alpha = alpha.gnu.org
  94 gnu_ftp_host-beta = alpha.gnu.org
  95 gnu_ftp_host-stable = ftp.gnu.org
  96 gnu_rel_host ?= $(gnu_ftp_host-$(RELEASE_TYPE))
  97
  98 ifeq ($(gnu_rel_host),ftp.gnu.org)
  99 url_dir_list ?= http://ftpmirror.gnu.org/$(PACKAGE)
 100 else
 101 url_dir_list ?= ftp://$(gnu_rel_host)/gnu/$(PACKAGE)
 102 endif
 103
 104 # Override this in cfg.mk if you are using a different format in your
 105 # NEWS file.
 106 today = $(shell date +%Y-%m-%d)
 107
 108 # Select which lines of NEWS are searched for $(news-check-regexp).
 109 # This is a sed line number spec.  The default says that we search
 110 # lines 1..10 of NEWS for $(news-check-regexp).
 111 # If you want to search only line 3 or only lines 20-22, use "3" or "20,22".
 112 news-check-lines-spec ?= 1,10
 113 news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)'
 114
 115 # Prevent programs like 'sort' from considering distinct strings to be equal.
 116 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
 117 export LC_ALL = C
 118
 119 ## --------------- ##
 120 ## Sanity checks.  ##
 121 ## --------------- ##
 122
 123 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
 124
 125 # Collect the names of rules starting with `sc_'.
 126 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
 127                         $(srcdir)/$(ME) $(_cfg_mk)))
 128 .PHONY: $(syntax-check-rules)
 129
 130 ifeq ($(shell $(VC_LIST) >/dev/null 2>&1; echo $$?),0)
 131 local-checks-available += $(syntax-check-rules)
 132 else
 133 local-checks-available += no-vc-detected
 134 no-vc-detected:
 135         @echo "No version control files detected; skipping syntax check"
 136 endif
 137 .PHONY: $(local-checks-available)
 138
 139 # Arrange to print the name of each syntax-checking rule just before running it.
 140 $(syntax-check-rules): %: %.m
 141 sc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules))
 142 .PHONY: $(sc_m_rules_)
 143 $(sc_m_rules_):
 144         @echo $(patsubst sc_%.m, %, $@)
 145         @date +%s.%N > .sc-start-$(basename $@)
 146
 147 # Compute and print the elapsed time for each syntax-check rule.
 148 sc_z_rules_ = $(patsubst %, %.z, $(syntax-check-rules))
 149 .PHONY: $(sc_z_rules_)
 150 $(sc_z_rules_): %.z: %
 151         @end=$$(date +%s.%N);                                           \
 152         start=$$(cat .sc-start-$*);                                     \
 153         rm -f .sc-start-$*;                                             \
 154         awk -v s=$$start -v e=$$end                                     \
 155           'END {printf "%.2f $(patsubst sc_%,%,$*)\n", e - s}' < /dev/null
 156
 157 # The patsubst here is to replace each sc_% rule with its sc_%.z wrapper
 158 # that computes and prints elapsed time.
 159 local-check :=                                                          \
 160   $(patsubst sc_%, sc_%.z,                                              \
 161     $(filter-out $(local-checks-to-skip), $(local-checks-available)))
 162
 163 syntax-check: $(local-check)
 164
 165 # _sc_search_regexp
 166 #
 167 # This macro searches for a given construct in the selected files and
 168 # then takes some action.
 169 #
 170 # Parameters (shell variables):
 171 #
 172 #  prohibit | require
 173 #
 174 #     Regular expression (ERE) denoting either a forbidden construct
 175 #     or a required construct.  Those arguments are exclusive.
 176 #
 177 #  in_vc_files | in_files
 178 #
 179 #     grep-E-style regexp denoting the files to check.  If no files
 180 #     are specified the default are all the files that are under
 181 #     version control.
 182 #
 183 #  containing | non_containing
 184 #
 185 #     Select the files (non) containing strings matching this regexp.
 186 #     If both arguments are specified then CONTAINING takes
 187 #     precedence.
 188 #
 189 #  with_grep_options
 190 #
 191 #     Extra options for grep.
 192 #
 193 #  ignore_case
 194 #
 195 #     Ignore case.
 196 #
 197 #  halt
 198 #
 199 #     Message to display before to halting execution.
 200 #
 201 # Finally, you may exempt files based on an ERE matching file names.
 202 # For example, to exempt from the sc_space_tab check all files with the
 203 # .diff suffix, set this Make variable:
 204 #
 205 # exclude_file_name_regexp--sc_space_tab = \.diff$
 206 #
 207 # Note that while this functionality is mostly inherited via VC_LIST_EXCEPT,
 208 # when filtering by name via in_files, we explicitly filter out matching
 209 # names here as well.
 210
 211 # By default, _sc_search_regexp does not ignore case.
 212 export ignore_case =
 213 _ignore_case = $$(test -n "$$ignore_case" && printf %s -i || :)
 214
 215 define _sc_say_and_exit
 216    dummy=; : so we do not need a semicolon before each use;             \
 217    { printf '%s\n' "$(ME): $$msg" 1>&2; exit 1; };
 218 endef
 219
 220 # _sc_search_regexp used to be named _prohibit_regexp.  However,
 221 # upgrading to the new definition and leaving the old name undefined
 222 # would usually convert each custom rule using $(_prohibit_regexp)
 223 # (usually defined in cfg.mk) into a no-op.  This definition ensures
 224 # that people know right away if they're still using the old name.
 225 # FIXME: remove in 2012.
 226 _prohibit_regexp = \
 227   $(error '*** you need to s/_prohibit_regexp/_sc_search_regexp/, and adapt')
 228
 229 define _sc_search_regexp
 230    dummy=; : so we do not need a semicolon before each use;             \
 231                                                                         \
 232    : Check arguments;                                                   \
 233    test -n "$$prohibit" && test -n "$$require"                          \
 234      && { msg='Cannot specify both prohibit and require'                \
 235           $(_sc_say_and_exit) } || :;                                   \
 236    test -z "$$prohibit" && test -z "$$require"                          \
 237      && { msg='Should specify either prohibit or require'               \
 238           $(_sc_say_and_exit) } || :;                                   \
 239    test -n "$$in_vc_files" && test -n "$$in_files"                      \
 240      && { msg='Cannot specify both in_vc_files and in_files'            \
 241           $(_sc_say_and_exit) } || :;                                   \
 242    test "x$$halt" != x                                                  \
 243      || { msg='halt not defined' $(_sc_say_and_exit) };                 \
 244                                                                         \
 245    : Filter by file name;                                               \
 246    if test -n "$$in_files"; then                                        \
 247      files=$$(find $(srcdir) | grep -E "$$in_files"                     \
 248               | grep -Ev '$(exclude_file_name_regexp--$@)');            \
 249    else                                                                 \
 250      files=$$($(VC_LIST_EXCEPT));                                       \
 251      if test -n "$$in_vc_files"; then                                   \
 252        files=$$(echo "$$files" | grep -E "$$in_vc_files");              \
 253      fi;                                                                \
 254    fi;                                                                  \
 255                                                                         \
 256    : Filter by content;                                                 \
 257    test -n "$$files" && test -n "$$containing"                          \
 258      && { files=$$(grep -l "$$containing" $$files); } || :;             \
 259    test -n "$$files" && test -n "$$non_containing"                      \
 260      && { files=$$(grep -vl "$$non_containing" $$files); } || :;        \
 261                                                                         \
 262    : Check for the construct;                                           \
 263    if test -n "$$files"; then                                           \
 264      if test -n "$$prohibit"; then                                      \
 265        grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \
 266          && { msg="$$halt" $(_sc_say_and_exit) } || :;                  \
 267      else                                                               \
 268        grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \
 269            | grep .                                                     \
 270          && { msg="$$halt" $(_sc_say_and_exit) } || :;                  \
 271      fi                                                                 \
 272    else :;                                                              \
 273    fi || :;
 274 endef
 275
 276 sc_avoid_if_before_free:
 277         @$(build_aux)/useless-if-before-free                            \
 278                 $(useless_free_options)                                 \
 279             $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) &&   \
 280           { echo '$(ME): found useless "if" before "free" above' 1>&2;  \
 281             exit 1; } || :
 282
 283 sc_cast_of_argument_to_free:
 284         @prohibit='\<free *\( *\(' halt='don'\''t cast free argument'   \
 285           $(_sc_search_regexp)
 286
 287 sc_cast_of_x_alloc_return_value:
 288         @prohibit='\*\) *x(m|c|re)alloc\>'                              \
 289         halt='don'\''t cast x*alloc return value'                       \
 290           $(_sc_search_regexp)
 291
 292 sc_cast_of_alloca_return_value:
 293         @prohibit='\*\) *alloca\>'                                      \
 294         halt='don'\''t cast alloca return value'                        \
 295           $(_sc_search_regexp)
 296
 297 sc_space_tab:
 298         @prohibit='[ ]  '                                               \
 299         halt='found SPACE-TAB sequence; remove the SPACE'               \
 300           $(_sc_search_regexp)
 301
 302 # Don't use *scanf or the old ato* functions in `real' code.
 303 # They provide no error checking mechanism.
 304 # Instead, use strto* functions.
 305 sc_prohibit_atoi_atof:
 306         @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\('                           \
 307         halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q'   \
 308           $(_sc_search_regexp)
 309
 310 # Use STREQ rather than comparing strcmp == 0, or != 0.
 311 sc_prohibit_strcmp:
 312         @grep -nE '! *str''cmp *\(|\<str''cmp *\(.+\) *[!=]='   \
 313             $$($(VC_LIST_EXCEPT))                                       \
 314           | grep -vE ':# *define STRN?EQ\(' &&                          \
 315           { echo '$(ME): replace str''cmp calls above with STREQ/STRNEQ' \
 316                 1>&2; exit 1; } || :
 317
 318 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
 319 # Convert all uses automatically, via these two commands:
 320 # git grep -l '\<exit *(1)' \
 321 #  | grep -vEf .x-sc_prohibit_magic_number_exit \
 322 #  | xargs --no-run-if-empty \
 323 #      perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
 324 # git grep -l '\<exit *(0)' \
 325 #  | grep -vEf .x-sc_prohibit_magic_number_exit \
 326 #  | xargs --no-run-if-empty \
 327 #      perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
 328 sc_prohibit_magic_number_exit:
 329         @prohibit='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,'     \
 330         halt='use EXIT_* values rather than magic number'                       \
 331           $(_sc_search_regexp)
 332
 333 # Using EXIT_SUCCESS as the first argument to error is misleading,
 334 # since when that parameter is 0, error does not exit.  Use `0' instead.
 335 sc_error_exit_success:
 336         @prohibit='error *\(EXIT_SUCCESS,'                              \
 337         in_vc_files='\.[chly]$$'                                        \
 338         halt='found error (EXIT_SUCCESS'                                \
 339          $(_sc_search_regexp)
 340
 341 # `FATAL:' should be fully upper-cased in error messages
 342 # `WARNING:' should be fully upper-cased, or fully lower-cased
 343 sc_error_message_warn_fatal:
 344         @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT))              \
 345             | grep -E '"Warning|"Fatal|"fatal' &&                       \
 346           { echo '$(ME): use FATAL, WARNING or warning' 1>&2;           \
 347             exit 1; } || :
 348
 349 # Error messages should not start with a capital letter
 350 sc_error_message_uppercase:
 351         @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT))              \
 352             | grep -E '"[A-Z]'                                          \
 353             | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' &&           \
 354           { echo '$(ME): found capitalized error message' 1>&2;         \
 355             exit 1; } || :
 356
 357 # Error messages should not end with a period
 358 sc_error_message_period:
 359         @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT))              \
 360             | grep -E '[^."]\."' &&                                     \
 361           { echo '$(ME): found error message ending in period' 1>&2;    \
 362             exit 1; } || :
 363
 364 sc_file_system:
 365         @prohibit=file''system                                          \
 366         ignore_case=1                                                   \
 367         halt='found use of "file''system"; spell it "file system"'      \
 368           $(_sc_search_regexp)
 369
 370 # Don't use cpp tests of this symbol.  All code assumes config.h is included.
 371 sc_prohibit_have_config_h:
 372         @prohibit='^# *if.*HAVE''_CONFIG_H'                             \
 373         halt='found use of HAVE''_CONFIG_H; remove'                     \
 374           $(_sc_search_regexp)
 375
 376 # Nearly all .c files must include <config.h>.  However, we also permit this
 377 # via inclusion of a package-specific header, if cfg.mk specified one.
 378 # config_h_header must be suitable for grep -E.
 379 config_h_header ?= <config\.h>
 380 sc_require_config_h:
 381         @require='^# *include $(config_h_header)'                       \
 382         in_vc_files='\.c$$'                                             \
 383         halt='the above files do not include <config.h>'                \
 384           $(_sc_search_regexp)
 385
 386 # You must include <config.h> before including any other header file.
 387 # This can possibly be via a package-specific header, if given by cfg.mk.
 388 sc_require_config_h_first:
 389         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
 390           fail=0;                                                       \
 391           for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do             \
 392             grep '^# *include\>' $$i | sed 1q                           \
 393                 | grep -E '^# *include $(config_h_header)' > /dev/null  \
 394               || { echo $$i; fail=1; };                                 \
 395           done;                                                         \
 396           test $$fail = 1 &&                                            \
 397             { echo '$(ME): the above files include some other header'   \
 398                 'before <config.h>' 1>&2; exit 1; } || :;               \
 399         else :;                                                         \
 400         fi
 401
 402 sc_prohibit_HAVE_MBRTOWC:
 403         @prohibit='\bHAVE_MBRTOWC\b'                                    \
 404         halt="do not use $$prohibit; it is always defined"              \
 405           $(_sc_search_regexp)
 406
 407 # To use this "command" macro, you must first define two shell variables:
 408 # h: the header name, with no enclosing <> or ""
 409 # re: a regular expression that matches IFF something provided by $h is used.
 410 define _sc_header_without_use
 411   dummy=; : so we do not need a semicolon before each use;              \
 412   h_esc=`echo '[<"]'"$$h"'[">]'|sed 's/\./\\\\./g'`;                    \
 413   if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then              \
 414     files=$$(grep -l '^# *include '"$$h_esc"                            \
 415              $$($(VC_LIST_EXCEPT) | grep '\.c$$')) &&                   \
 416     grep -LE "$$re" $$files | grep . &&                                 \
 417       { echo "$(ME): the above files include $$h but don't use it"      \
 418         1>&2; exit 1; } || :;                                           \
 419   else :;                                                               \
 420   fi
 421 endef
 422
 423 # Prohibit the inclusion of assert.h without an actual use of assert.
 424 sc_prohibit_assert_without_use:
 425         @h='assert.h' re='\<assert *\(' $(_sc_header_without_use)
 426
 427 # Prohibit the inclusion of close-stream.h without an actual use.
 428 sc_prohibit_close_stream_without_use:
 429         @h='close-stream.h' re='\<close_stream *\(' $(_sc_header_without_use)
 430
 431 # Prohibit the inclusion of getopt.h without an actual use.
 432 sc_prohibit_getopt_without_use:
 433         @h='getopt.h' re='\<getopt(_long)? *\(' $(_sc_header_without_use)
 434
 435 # Don't include quotearg.h unless you use one of its functions.
 436 sc_prohibit_quotearg_without_use:
 437         @h='quotearg.h' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use)
 438
 439 # Don't include quote.h unless you use one of its functions.
 440 sc_prohibit_quote_without_use:
 441         @h='quote.h' re='\<quote(_n)? *\(' $(_sc_header_without_use)
 442
 443 # Don't include this header unless you use one of its functions.
 444 sc_prohibit_long_options_without_use:
 445         @h='long-options.h' re='\<parse_long_options *\(' \
 446           $(_sc_header_without_use)
 447
 448 # Don't include this header unless you use one of its functions.
 449 sc_prohibit_inttostr_without_use:
 450         @h='inttostr.h' re='\<(off|[iu]max|uint)tostr *\(' \
 451           $(_sc_header_without_use)
 452
 453 # Don't include this header unless you use one of its functions.
 454 sc_prohibit_ignore_value_without_use:
 455         @h='ignore-value.h' re='\<ignore_(value|ptr) *\(' \
 456           $(_sc_header_without_use)
 457
 458 # Don't include this header unless you use one of its functions.
 459 sc_prohibit_error_without_use:
 460         @h='error.h' \
 461         re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
 462           $(_sc_header_without_use)
 463
 464 # Don't include xalloc.h unless you use one of its functions.
 465 # Consider these symbols:
 466 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
 467 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h
 468 # Divide into two sets on case, and filter each through this:
 469 # | sort | perl -MRegexp::Assemble -le \
 470 #  'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
 471 # Note this was produced by the above:
 472 # _xa1 = \
 473 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
 474 # But we can do better, in at least two ways:
 475 # 1) take advantage of two "dup"-suffixed strings:
 476 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
 477 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
 478 # "char|[cmz]"
 479 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
 480 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
 481 _xa2 = X([CZ]|N?M)ALLOC
 482 sc_prohibit_xalloc_without_use:
 483         @h='xalloc.h' \
 484         re='\<($(_xa1)|$(_xa2)) *\('\
 485           $(_sc_header_without_use)
 486
 487 # Extract function names:
 488 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h
 489 _hash_re = \
 490 clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning
 491 _hash_fn = \<($(_hash_re)) *\(
 492 _hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>
 493 sc_prohibit_hash_without_use:
 494         @h='hash.h' \
 495         re='$(_hash_fn)|$(_hash_struct)'\
 496           $(_sc_header_without_use)
 497
 498 sc_prohibit_cloexec_without_use:
 499         @h='cloexec.h' re='\<(set_cloexec_flag|dup_cloexec) *\(' \
 500           $(_sc_header_without_use)
 501
 502 sc_prohibit_posixver_without_use:
 503         @h='posixver.h' re='\<posix2_version *\(' $(_sc_header_without_use)
 504
 505 sc_prohibit_same_without_use:
 506         @h='same.h' re='\<same_name *\(' $(_sc_header_without_use)
 507
 508 sc_prohibit_hash_pjw_without_use:
 509         @h='hash-pjw.h' \
 510         re='\<hash_pjw *\(' \
 511           $(_sc_header_without_use)
 512
 513 sc_prohibit_safe_read_without_use:
 514         @h='safe-read.h' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
 515           $(_sc_header_without_use)
 516
 517 sc_prohibit_argmatch_without_use:
 518         @h='argmatch.h' \
 519         re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<(invalid_arg|argmatch(_exit_fn|_(in)?valid)?) *\()' \
 520           $(_sc_header_without_use)
 521
 522 sc_prohibit_canonicalize_without_use:
 523         @h='canonicalize.h' \
 524         re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
 525           $(_sc_header_without_use)
 526
 527 sc_prohibit_root_dev_ino_without_use:
 528         @h='root-dev-ino.h' \
 529         re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
 530           $(_sc_header_without_use)
 531
 532 sc_prohibit_openat_without_use:
 533         @h='openat.h' \
 534         re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
 535           $(_sc_header_without_use)
 536
 537 # Prohibit the inclusion of c-ctype.h without an actual use.
 538 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
 539 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
 540 sc_prohibit_c_ctype_without_use:
 541         @h='c-ctype.h' re='\<c_($(ctype_re)) *\(' \
 542           $(_sc_header_without_use)
 543
 544 _empty =
 545 _sp = $(_empty) $(_empty)
 546 # The following list was generated by running:
 547 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
 548 #   | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
 549 _sig_functions = \
 550   bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
 551   sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
 552   siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
 553   sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
 554 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
 555 # The following were extracted from "man signal.h" manually.
 556 _sig_types_and_consts =                                                 \
 557   MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK           \
 558   SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL            \
 559   SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE    \
 560   SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t  \
 561   sigstack sigval stack_t ucontext_t
 562 # generated via this:
 563 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
 564 _sig_names =                                                            \
 565   SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT      \
 566   SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL       \
 567   SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP  \
 568   SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR      \
 569   SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS   \
 570   SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1        \
 571   SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW       \
 572   SIGXCPU SIGXFSZ
 573 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
 574
 575 # Prohibit the inclusion of signal.h without an actual use.
 576 sc_prohibit_signal_without_use:
 577         @h='signal.h'                                                   \
 578         re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>'          \
 579           $(_sc_header_without_use)
 580
 581 # Don't include stdio--.h unless you use one of its functions.
 582 sc_prohibit_stdio--_without_use:
 583         @h='stdio--.h' re='\<((f(re)?|p)open|tmpfile) *\('              \
 584           $(_sc_header_without_use)
 585
 586 # Don't include stdio-safer.h unless you use one of its functions.
 587 sc_prohibit_stdio-safer_without_use:
 588         @h='stdio-safer.h' re='\<((f(re)?|p)open|tmpfile)_safer *\('    \
 589           $(_sc_header_without_use)
 590
 591 # Prohibit the inclusion of strings.h without a sensible use.
 592 # Using the likes of bcmp, bcopy, bzero, index or rindex is not sensible.
 593 sc_prohibit_strings_without_use:
 594         @h='strings.h'                                                  \
 595         re='\<(strn?casecmp|ffs(ll)?)\>'                                \
 596           $(_sc_header_without_use)
 597
 598 # Get the list of symbol names with this:
 599 # perl -lne '/^# *define ([A-Z]\w+)\(/ and print $1' lib/intprops.h|fmt
 600 _intprops_names =                                                       \
 601   TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT             \
 602   TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM           \
 603   INT_BITS_STRLEN_BOUND INT_STRLEN_BOUND INT_BUFSIZE_BOUND              \
 604   INT_ADD_RANGE_OVERFLOW INT_SUBTRACT_RANGE_OVERFLOW                    \
 605   INT_NEGATE_RANGE_OVERFLOW INT_MULTIPLY_RANGE_OVERFLOW                 \
 606   INT_DIVIDE_RANGE_OVERFLOW INT_REMAINDER_RANGE_OVERFLOW                \
 607   INT_LEFT_SHIFT_RANGE_OVERFLOW INT_ADD_OVERFLOW INT_SUBTRACT_OVERFLOW  \
 608   INT_NEGATE_OVERFLOW INT_MULTIPLY_OVERFLOW INT_DIVIDE_OVERFLOW         \
 609   INT_REMAINDER_OVERFLOW INT_LEFT_SHIFT_OVERFLOW
 610 _intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names)))
 611 # Prohibit the inclusion of intprops.h without an actual use.
 612 sc_prohibit_intprops_without_use:
 613         @h='intprops.h'                                                 \
 614         re='\<($(_intprops_syms_re)) *\('                               \
 615           $(_sc_header_without_use)
 616
 617 _stddef_syms_re = NULL|offsetof|ptrdiff_t|size_t|wchar_t
 618 # Prohibit the inclusion of stddef.h without an actual use.
 619 sc_prohibit_stddef_without_use:
 620         @h='stddef.h'                                                   \
 621         re='\<($(_stddef_syms_re)) *\('                                 \
 622           $(_sc_header_without_use)
 623
 624 # Prohibit the inclusion of verify.h without an actual use.
 625 sc_prohibit_verify_without_use:
 626         @h='verify.h'                                                   \
 627         re='\<(verify(true|expr)?|static_assert) *\('                   \
 628           $(_sc_header_without_use)
 629
 630 # Don't include xfreopen.h unless you use one of its functions.
 631 sc_prohibit_xfreopen_without_use:
 632         @h='xfreopen.h' re='\<xfreopen *\(' $(_sc_header_without_use)
 633
 634 sc_obsolete_symbols:
 635         @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>'                     \
 636         halt='do not use HAVE''_FCNTL_H or O'_NDELAY                    \
 637           $(_sc_search_regexp)
 638
 639 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
 640
 641 # Each nonempty ChangeLog line must start with a year number, or a TAB.
 642 sc_changelog:
 643         @prohibit='^[^12        ]'                                      \
 644         in_vc_files='^ChangeLog$$'                                      \
 645         halt='found unexpected prefix in a ChangeLog'                   \
 646           $(_sc_search_regexp)
 647
 648 # Ensure that each .c file containing a "main" function also
 649 # calls set_program_name.
 650 sc_program_name:
 651         @require='set_program_name *\(m?argv\[0\]\);'                   \
 652         in_vc_files='\.c$$'                                             \
 653         containing='\<main *('                                          \
 654         halt='the above files do not call set_program_name'             \
 655           $(_sc_search_regexp)
 656
 657 # Ensure that each .c file containing a "main" function also
 658 # calls bindtextdomain.
 659 sc_bindtextdomain:
 660         @require='bindtextdomain *\('                                   \
 661         in_vc_files='\.c$$'                                             \
 662         containing='\<main *('                                          \
 663         halt='the above files do not call bindtextdomain'               \
 664           $(_sc_search_regexp)
 665
 666 # Require that the final line of each test-lib.sh-using test be this one:
 667 # Exit $fail
 668 # Note: this test requires GNU grep's --label= option.
 669 Exit_witness_file ?= tests/test-lib.sh
 670 Exit_base := $(notdir $(Exit_witness_file))
 671 sc_require_test_exit_idiom:
 672         @if test -f $(srcdir)/$(Exit_witness_file); then                \
 673           die=0;                                                        \
 674           for i in $$(grep -l -F 'srcdir/$(Exit_base)'                  \
 675                 $$($(VC_LIST) tests)); do                               \
 676             tail -n1 $$i | grep '^Exit .' > /dev/null                   \
 677               && : || { die=1; echo $$i; }                              \
 678           done;                                                         \
 679           test $$die = 1 &&                                             \
 680             { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
 681               echo 1>&2 'Exit something';                               \
 682               exit 1; } || :;                                           \
 683         fi
 684
 685 sc_trailing_blank:
 686         @prohibit='[     ]$$'                                           \
 687         halt='found trailing blank(s)'                                  \
 688           $(_sc_search_regexp)
 689
 690 # Match lines like the following, but where there is only one space
 691 # between the options and the description:
 692 #   -D, --all-repeated[=delimit-method]  print all duplicate lines\n
 693 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
 694 sc_two_space_separator_in_usage:
 695         @prohibit='^   *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$'         \
 696         halt='help2man requires at least two spaces between an option and its description'\
 697           $(_sc_search_regexp)
 698
 699 # A regexp matching function names like "error" that may be used
 700 # to emit translatable messages.
 701 _gl_translatable_diag_func_re ?= error
 702
 703 # Look for diagnostics that aren't marked for translation.
 704 # This won't find any for which error's format string is on a separate line.
 705 sc_unmarked_diagnostics:
 706         @grep -nE                                                       \
 707             '\<$(_gl_translatable_diag_func_re) *\([^"]*"[^"]*[a-z]{3}' \
 708                 $$($(VC_LIST_EXCEPT))                                   \
 709           | grep -Ev '(_|ngettext ?)\(' &&                              \
 710           { echo '$(ME): found unmarked diagnostic(s)' 1>&2;            \
 711             exit 1; } || :
 712
 713 # Avoid useless parentheses like those in this example:
 714 # #if defined (SYMBOL) || defined (SYM2)
 715 sc_useless_cpp_parens:
 716         @prohibit='^# *if .*defined *\('                                \
 717         halt='found useless parentheses in cpp directive'               \
 718           $(_sc_search_regexp)
 719
 720 # List headers for which HAVE_HEADER_H is always true, assuming you are
 721 # using the appropriate gnulib module.  CAUTION: for each "unnecessary"
 722 # #if HAVE_HEADER_H that you remove, be sure that your project explicitly
 723 # requires the gnulib module that guarantees the usability of that header.
 724 gl_assured_headers_ = \
 725   cd $(gnulib_dir)/lib && echo *.in.h|sed 's/\.in\.h//g'
 726
 727 # Convert the list of names to upper case, and replace each space with "|".
 728 az_ = abcdefghijklmnopqrstuvwxyz
 729 AZ_ = ABCDEFGHIJKLMNOPQRSTUVWXYZ
 730 gl_header_upper_case_or_ =                                              \
 731   $$($(gl_assured_headers_)                                             \
 732     | tr $(az_)/.- $(AZ_)___                                            \
 733     | tr -s ' ' '|'                                                     \
 734     )
 735 sc_prohibit_always_true_header_tests:
 736         @or=$(gl_header_upper_case_or_);                                \
 737         re="HAVE_($$or)_H";                                             \
 738         prohibit='\<'"$$re"'\>'                                         \
 739         halt=$$(printf '%s\n'                                           \
 740         'do not test the above HAVE_<header>_H symbol(s);'              \
 741         '  with the corresponding gnulib module, they are always true') \
 742           $(_sc_search_regexp)
 743
 744 # ==================================================================
 745 gl_other_headers_ ?= \
 746   intprops.h    \
 747   openat.h      \
 748   stat-macros.h
 749
 750 # Perl -lne code to extract "significant" cpp-defined symbols from a
 751 # gnulib header file, eliminating a few common false-positives.
 752 gl_extract_significant_defines_ = \
 753   /^\# *define ([^_ (][^ (]*)(\s*\(|\s+\w+)/\
 754     && $$2 !~ /(?:rpl_|_used_without_)/\
 755     && $$1 !~ /^(?:NSIG)$$/\
 756     and print $$1
 757
 758 # Create a list of regular expressions matching the names
 759 # of macros that are guaranteed to be defined by parts of gnulib.
 760 define def_sym_regex
 761         gen_h=$(gl_generated_headers_);                                 \
 762         (cd $(gnulib_dir)/lib;                                          \
 763           for f in *.in.h $(gl_other_headers_); do                      \
 764             perl -lne '$(gl_extract_significant_defines_)' $$f;         \
 765           done;                                                         \
 766         ) | sort -u                                                     \
 767           | sed 's/^/^ *# *(define|undef)  */;s/$$/\\>/'
 768 endef
 769
 770 # Don't define macros that we already get from gnulib header files.
 771 sc_prohibit_always-defined_macros:
 772         @if test -d $(gnulib_dir); then                                 \
 773           case $$(echo all: | grep -l -f - Makefile) in Makefile);; *)  \
 774             echo '$(ME): skipping $@: you lack GNU grep' 1>&2; exit 0;; \
 775           esac;                                                         \
 776           $(def_sym_regex) | grep -E -f - $$($(VC_LIST_EXCEPT))         \
 777             && { echo '$(ME): define the above via some gnulib .h file' \
 778                   1>&2;  exit 1; } || :;                                \
 779         fi
 780 # ==================================================================
 781
 782 # Prohibit checked in backup files.
 783 sc_prohibit_backup_files:
 784         @$(VC_LIST) | grep '~$$' &&                             \
 785           { echo '$(ME): found version controlled backup file' 1>&2;    \
 786             exit 1; } || :
 787
 788 # Require the latest GPL.
 789 sc_GPL_version:
 790         @prohibit='either ''version [^3]'                               \
 791         halt='GPL vN, N!=3'                                             \
 792           $(_sc_search_regexp)
 793
 794 # Require the latest GFDL.  Two regexp, since some .texi files end up
 795 # line wrapping between 'Free Documentation License,' and 'Version'.
 796 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
 797 sc_GFDL_version:
 798         @prohibit='$(_GFDL_regexp)'                                     \
 799         halt='GFDL vN, N!=3'                                            \
 800           $(_sc_search_regexp)
 801
 802 # Don't use Texinfo's @acronym{}.
 803 # http://lists.gnu.org/archive/html/bug-gnulib/2010-03/msg00321.html
 804 texinfo_suffix_re_ ?= \.(txi|texi(nfo)?)$$
 805 sc_texinfo_acronym:
 806         @prohibit='@acronym\{'                                          \
 807         in_vc_files='$(texinfo_suffix_re_)'                             \
 808         halt='found use of Texinfo @acronym{}'                          \
 809           $(_sc_search_regexp)
 810
 811 cvs_keywords = \
 812   Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
 813
 814 sc_prohibit_cvs_keyword:
 815         @prohibit='\$$($(cvs_keywords))\$$'                             \
 816         halt='do not use CVS keyword expansion'                         \
 817           $(_sc_search_regexp)
 818
 819 # This Perl code is slightly obfuscated.  Not only is each "$" doubled
 820 # because it's in a Makefile, but the $$c's are comments;  we cannot
 821 # use "#" due to the way the script ends up concatenated onto one line.
 822 # It would be much more concise, and would produce better output (including
 823 # counts) if written as:
 824 #   perl -ln -0777 -e '/\n(\n+)$/ and print "$ARGV: ".length $1' ...
 825 # but that would be far less efficient, reading the entire contents
 826 # of each file, rather than just the last two bytes of each.
 827 # In addition, while the code below detects both blank lines and a missing
 828 # newline at EOF, the above detects only the former.
 829 #
 830 # This is a perl script that is expected to be the single-quoted argument
 831 # to a command-line "-le".  The remaining arguments are file names.
 832 # Print the name of each file that ends in exactly one newline byte.
 833 # I.e., warn if there are blank lines (2 or more newlines), or if the
 834 # last byte is not a newline.  However, currently we don't complain
 835 # about any file that contains exactly one byte.
 836 # Exit nonzero if at least one such file is found, otherwise, exit 0.
 837 # Warn about, but otherwise ignore open failure.  Ignore seek/read failure.
 838 #
 839 # Use this if you want to remove trailing empty lines from selected files:
 840 #   perl -pi -0777 -e 's/\n\n+$/\n/' files...
 841 #
 842 require_exactly_one_NL_at_EOF_ =                                        \
 843   foreach my $$f (@ARGV)                                                \
 844     {                                                                   \
 845       open F, "<", $$f or (warn "failed to open $$f: $$!\n"), next;     \
 846       my $$p = sysseek (F, -2, 2);                                      \
 847       my $$c = "seek failure probably means file has < 2 bytes; ignore"; \
 848       my $$last_two_bytes;                                              \
 849       defined $$p and $$p = sysread F, $$last_two_bytes, 2;             \
 850       close F;                                                          \
 851       $$c = "ignore read failure";                                      \
 852       $$p && ($$last_two_bytes eq "\n\n"                                \
 853               || substr ($$last_two_bytes,1) ne "\n")                   \
 854           and (print $$f), $$fail=1;                                    \
 855     }                                                                   \
 856   END { exit defined $$fail }
 857 sc_prohibit_empty_lines_at_EOF:
 858         @perl -le '$(require_exactly_one_NL_at_EOF_)' $$($(VC_LIST_EXCEPT)) \
 859           || { echo '$(ME): empty line(s) or no newline at EOF'         \
 860                 1>&2; exit 1; } || :
 861
 862 # Make sure we don't use st_blocks.  Use ST_NBLOCKS instead.
 863 # This is a bit of a kludge, since it prevents use of the string
 864 # even in comments, but for now it does the job with no false positives.
 865 sc_prohibit_stat_st_blocks:
 866         @prohibit='[.>]st_blocks'                                       \
 867         halt='do not use st_blocks; use ST_NBLOCKS'                     \
 868           $(_sc_search_regexp)
 869
 870 # Make sure we don't define any S_IS* macros in src/*.c files.
 871 # They're already defined via gnulib's sys/stat.h replacement.
 872 sc_prohibit_S_IS_definition:
 873         @prohibit='^ *# *define  *S_IS'                                 \
 874         halt='do not define S_IS* macros; include <sys/stat.h>'         \
 875           $(_sc_search_regexp)
 876
 877 # Perl block to convert a match to FILE_NAME:LINENO:TEST,
 878 # that is shared by two definitions below.
 879 perl_filename_lineno_text_ =                                            \
 880     -e '  {'                                                            \
 881     -e '    $$n = ($$` =~ tr/\n/\n/ + 1);'                              \
 882     -e '    ($$v = $$&) =~ s/\n/\\n/g;'                                 \
 883     -e '    print "$$ARGV:$$n:$$v\n";'                                  \
 884     -e '  }'
 885
 886 prohibit_doubled_word_RE_ ?= \
 887   /\b(then?|[iao]n|i[fst]|but|f?or|at|and|[dt]o)\s+\1\b/gims
 888 prohibit_doubled_word_ =                                                \
 889     -e 'while ($(prohibit_doubled_word_RE_))'                           \
 890     $(perl_filename_lineno_text_)
 891
 892 # Define this to a regular expression that matches
 893 # any filename:dd:match lines you want to ignore.
 894 # The default is to ignore no matches.
 895 ignore_doubled_word_match_RE_ ?= ^$$
 896
 897 sc_prohibit_doubled_word:
 898         @perl -n -0777 $(prohibit_doubled_word_) $$($(VC_LIST_EXCEPT))  \
 899           | grep -vE '$(ignore_doubled_word_match_RE_)'                 \
 900           | grep . && { echo '$(ME): doubled words' 1>&2; exit 1; } || :
 901
 902 # A regular expression matching undesirable combinations of words like
 903 # "can not"; this matches them even when the two words appear on different
 904 # lines, but not when there is an intervening delimiter like "#" or "*".
 905 prohibit_undesirable_word_seq_RE_ ?=                                    \
 906   /\bcan\s+not\b/gims
 907 prohibit_undesirable_word_seq_ =                                        \
 908     -e 'while ($(prohibit_undesirable_word_seq_RE_))'                   \
 909     $(perl_filename_lineno_text_)
 910 # Define this to a regular expression that matches
 911 # any filename:dd:match lines you want to ignore.
 912 # The default is to ignore no matches.
 913 ignore_undesirable_word_sequence_RE_ ?= ^$$
 914
 915 sc_prohibit_undesirable_word_seq:
 916         @perl -n -0777 $(prohibit_undesirable_word_seq_)                \
 917              $$($(VC_LIST_EXCEPT))                                      \
 918           | grep -vE '$(ignore_undesirable_word_sequence_RE_)' | grep . \
 919           && { echo '$(ME): undesirable word sequence' >&2; exit 1; } || :
 920
 921 _ptm1 = use "test C1 && test C2", not "test C1 -''a C2"
 922 _ptm2 = use "test C1 || test C2", not "test C1 -''o C2"
 923 # Using test's -a and -o operators is not portable.
 924 # We prefer test over [, since the latter is spelled [[ in configure.ac.
 925 sc_prohibit_test_minus_ao:
 926         @prohibit='(\<test| \[+) .+ -[ao] '                             \
 927         halt='$(_ptm1); $(_ptm2)'                                       \
 928           $(_sc_search_regexp)
 929
 930 # Avoid a test bashism.
 931 sc_prohibit_test_double_equal:
 932         @prohibit='(\<test| \[+) .+ == '                                \
 933         containing='#! */bin/[a-z]*sh'                                  \
 934         halt='use "test x = x", not "test x =''= x"'                    \
 935           $(_sc_search_regexp)
 936
 937 # Each program that uses proper_name_utf8 must link with one of the
 938 # ICONV libraries.  Otherwise, some ICONV library must appear in LDADD.
 939 # The perl -0777 invocation below extracts the possibly-multi-line
 940 # definition of LDADD from the appropriate Makefile.am and exits 0
 941 # when it contains "ICONV".
 942 sc_proper_name_utf8_requires_ICONV:
 943         @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
 944         if test "x$$progs" != x; then                                   \
 945           fail=0;                                                       \
 946           for p in $$progs; do                                          \
 947             dir=$$(dirname "$$p");                                      \
 948             perl -0777                                                  \
 949               -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)'  \
 950               $$dir/Makefile.am && continue;                            \
 951             base=$$(basename "$$p" .c);                                 \
 952             grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
 953               || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
 954           done;                                                         \
 955           test $$fail = 1 &&                                            \
 956             { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
 957               exit 1; } || :;                                           \
 958         fi
 959
 960 # Warn about "c0nst struct Foo const foo[]",
 961 # but not about "char const *const foo" or "#define const const".
 962 sc_redundant_const:
 963         @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b'          \
 964         halt='redundant "const" in declarations'                        \
 965           $(_sc_search_regexp)
 966
 967 sc_const_long_option:
 968         @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT))         \
 969           | grep -Ev 'const struct option|struct option const' && {     \
 970               echo 1>&2 '$(ME): add "const" to the above declarations'; \
 971               exit 1; } || :
 972
 973 NEWS_hash =                                                             \
 974   $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p'              \
 975        $(srcdir)/NEWS                                                   \
 976      | perl -0777 -pe                                                   \
 977         's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms'       \
 978      | md5sum -                                                         \
 979      | sed 's/ .*//')
 980
 981 # Ensure that we don't accidentally insert an entry into an old NEWS block.
 982 sc_immutable_NEWS:
 983         @if test -f $(srcdir)/NEWS; then                                \
 984           test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : ||              \
 985             { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
 986         fi
 987
 988 # Update the hash stored above.  Do this after each release and
 989 # for any corrections to old entries.
 990 update-NEWS-hash: NEWS
 991         perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
 992           $(srcdir)/cfg.mk
 993
 994 # Ensure that we use only the standard $(VAR) notation,
 995 # not @...@ in Makefile.am, now that we can rely on automake
 996 # to emit a definition for each substituted variable.
 997 # However, there is still one case in which @VAR@ use is not just
 998 # legitimate, but actually required: when augmenting an automake-defined
 999 # variable with a prefix.  For example, gettext uses this:
1000 # MAKEINFO = env LANG= LC_MESSAGES= LC_ALL= LANGUAGE= @MAKEINFO@
1001 # otherwise, makeinfo would put German or French (current locale)
1002 # navigation hints in the otherwise-English documentation.
1003 #
1004 # Allow the package to add exceptions via a hook in cfg.mk;
1005 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
1006 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
1007 _makefile_at_at_check_exceptions ?=
1008 sc_makefile_at_at_check:
1009         @perl -ne '/\@[A-Z_0-9]+\@/'                                    \
1010           -e ' && !/([A-Z_0-9]+)\s+=.*\@\1\@$$/'                        \
1011           -e ''$(_makefile_at_at_check_exceptions)                      \
1012           -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}'    \
1013             $$($(VC_LIST_EXCEPT) | grep -E '(^|/)(Makefile\.am|[^/]+\.mk)$$') \
1014           && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
1015
1016 news-check: NEWS
1017         if sed -n $(news-check-lines-spec)p $(srcdir)/NEWS              \
1018             | grep -E $(news-check-regexp) >/dev/null; then             \
1019           :;                                                            \
1020         else                                                            \
1021           echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2;      \
1022           exit 1;                                                       \
1023         fi
1024
1025 sc_makefile_TAB_only_indentation:
1026         @prohibit='^    [ ]{8}'                                         \
1027         in_vc_files='akefile|\.mk$$'                                    \
1028         halt='found TAB-8-space indentation'                            \
1029           $(_sc_search_regexp)
1030
1031 sc_m4_quote_check:
1032         @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]'              \
1033         in_vc_files='(^configure\.ac|\.m4)$$'                           \
1034         halt='quote the first arg to AC_DEF*'                           \
1035           $(_sc_search_regexp)
1036
1037 fix_po_file_diag = \
1038 'you have changed the set of files with translatable diagnostics;\n\
1039 apply the above patch\n'
1040
1041 # Verify that all source files using _() are listed in po/POTFILES.in.
1042 po_file ?= $(srcdir)/po/POTFILES.in
1043 generated_files ?= $(srcdir)/lib/*.[ch]
1044 sc_po_check:
1045         @if test -f $(po_file); then                                    \
1046           grep -E -v '^(#|$$)' $(po_file)                               \
1047             | grep -v '^src/false\.c$$' | sort > $@-1;                  \
1048           files=;                                                       \
1049           for file in $$($(VC_LIST_EXCEPT)) $(generated_files); do      \
1050             test -r $$file || continue;                                 \
1051             case $$file in                                              \
1052               *.m4|*.mk) continue ;;                                    \
1053               *.?|*.??) ;;                                              \
1054               *) continue;;                                             \
1055             esac;                                                       \
1056             case $$file in                                              \
1057             *.[ch])                                                     \
1058               base=`expr " $$file" : ' \(.*\)\..'`;                     \
1059               { test -f $$base.l || test -f $$base.y; } && continue;;   \
1060             esac;                                                       \
1061             files="$$files $$file";                                     \
1062           done;                                                         \
1063           grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files          \
1064             | sed 's|^$(_dot_escaped_srcdir)/||' | sort -u > $@-2;      \
1065           diff -u -L $(po_file) -L $(po_file) $@-1 $@-2                 \
1066             || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; };   \
1067           rm -f $@-1 $@-2;                                              \
1068         fi
1069
1070 # Sometimes it is useful to change the PATH environment variable
1071 # in Makefiles.  When doing so, it's better not to use the Unix-centric
1072 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
1073 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
1074 sc_makefile_path_separator_check:
1075         @prohibit='PATH[=].*:'                                          \
1076         in_vc_files='akefile|\.mk$$'                                    \
1077         halt=$(msg)                                                     \
1078           $(_sc_search_regexp)
1079
1080 # Check that `make alpha' will not fail at the end of the process.
1081 writable-files:
1082         if test -d $(release_archive_dir); then :; else                 \
1083           for file in $(distdir).tar.gz                                 \
1084                       $(release_archive_dir)/$(distdir).tar.gz; do      \
1085             test -e $$file || continue;                                 \
1086             test -w $$file                                              \
1087               || { echo ERROR: $$file is not writable; fail=1; };       \
1088           done;                                                         \
1089           test "$$fail" && exit 1 || : ;                                \
1090         fi
1091
1092 v_etc_file = $(gnulib_dir)/lib/version-etc.c
1093 sample-test = tests/sample-test
1094 texi = doc/$(PACKAGE).texi
1095 # Make sure that the copyright date in $(v_etc_file) is up to date.
1096 # Do the same for the $(sample-test) and the main doc/.texi file.
1097 sc_copyright_check:
1098         @require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };'            \
1099         in_files=$(v_etc_file)                                          \
1100         halt='out of date copyright in $(v_etc_file); update it'        \
1101           $(_sc_search_regexp)
1102         @require='# Copyright \(C\) '$$(date +%Y)' Free'                \
1103         in_vc_files=$(sample-test)                                      \
1104         halt='out of date copyright in $(sample-test); update it'       \
1105           $(_sc_search_regexp)
1106         @require='Copyright @copyright\{\} .*'$$(date +%Y)' Free'       \
1107         in_vc_files=$(texi)                                             \
1108         halt='out of date copyright in $(texi); update it'              \
1109           $(_sc_search_regexp)
1110
1111 # If tests/help-version exists and seems to be new enough, assume that its
1112 # use of init.sh and path_prepend_ is correct, and ensure that every other
1113 # use of init.sh is identical.
1114 # This is useful because help-version cross-checks prog --version
1115 # with $(VERSION), which verifies that its path_prepend_ invocation
1116 # sets PATH correctly.  This is an inexpensive way to ensure that
1117 # the other init.sh-using tests also get it right.
1118 _hv_file ?= $(srcdir)/tests/help-version
1119 _hv_regex_weak ?= ^ *\. .*/init\.sh"
1120 # Fix syntax-highlighters "
1121 _hv_regex_strong ?= ^ *\. "\$${srcdir=\.}/init\.sh"
1122 sc_cross_check_PATH_usage_in_tests:
1123         @if test -f $(_hv_file); then                                   \
1124           grep -l 'VERSION mismatch' $(_hv_file) >/dev/null             \
1125             || { echo "$@: skipped: no such file: $(_hv_file)" 1>&2;    \
1126                  exit 0; };                                             \
1127           grep -lE '$(_hv_regex_strong)' $(_hv_file) >/dev/null         \
1128             || { echo "$@: $(_hv_file) lacks conforming use of init.sh" 1>&2; \
1129                  exit 1; };                                             \
1130           good=$$(grep -E '$(_hv_regex_strong)' $(_hv_file));           \
1131           grep -LFx "$$good"                                            \
1132                 $$(grep -lE '$(_hv_regex_weak)' $$($(VC_LIST_EXCEPT)))  \
1133               | grep . &&                                               \
1134             { echo "$(ME): the above files use path_prepend_ inconsistently" \
1135                 1>&2; exit 1; } || :;                                   \
1136         fi
1137
1138 # #if HAVE_... will evaluate to false for any non numeric string.
1139 # That would be flagged by using -Wundef, however gnulib currently
1140 # tests many undefined macros, and so we can't enable that option.
1141 # So at least preclude common boolean strings as macro values.
1142 sc_Wundef_boolean:
1143         @prohibit='^#define.*(yes|no|true|false)$$'                     \
1144         in_files='$(CONFIG_INCLUDE)'                                    \
1145         halt='Use 0 or 1 for macro values'                              \
1146           $(_sc_search_regexp)
1147
1148 # Even if you use pathmax.h to guarantee that PATH_MAX is defined, it might
1149 # not be constant, or might overflow a stack.  In general, use PATH_MAX as
1150 # a limit, not an array or alloca size.
1151 sc_prohibit_path_max_allocation:
1152         @prohibit='(\balloca *\([^)]*|\[[^]]*)PATH_MAX'                 \
1153         halt='Avoid stack allocations of size PATH_MAX'                 \
1154           $(_sc_search_regexp)
1155
1156 sc_vulnerable_makefile_CVE-2009-4029:
1157         @prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \
1158         in_files=$$(find $(srcdir) -name Makefile.in)                   \
1159         halt=$$(printf '%s\n'                                           \
1160           'the above files are vulnerable; beware of running'           \
1161           '  "make dist*" rules, and upgrade to fixed automake'         \
1162           '  see http://bugzilla.redhat.com/542609 for details')        \
1163           $(_sc_search_regexp)
1164
1165 vc-diff-check:
1166         (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
1167         if test -s vc-diffs; then                               \
1168           cat vc-diffs;                                         \
1169           echo "Some files are locally modified:" 1>&2;         \
1170           exit 1;                                               \
1171         else                                                    \
1172           rm vc-diffs;                                          \
1173         fi
1174
1175 rel-files = $(DIST_ARCHIVES)
1176
1177 gnulib_dir ?= $(srcdir)/gnulib
1178 gnulib-version = $$(cd $(gnulib_dir) && git describe)
1179 bootstrap-tools ?= autoconf,automake,gnulib
1180
1181 # If it's not already specified, derive the GPG key ID from
1182 # the signed tag we've just applied to mark this release.
1183 gpg_key_ID ?= \
1184   $$(git cat-file tag v$(VERSION) > .ann-sig \
1185      && gpgv .ann-sig - < /dev/null 2>&1 \
1186           | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
1187
1188 translation_project_ ?= coordinator@translationproject.org
1189
1190 # Make info-gnu the default only for a stable release.
1191 ifeq ($(RELEASE_TYPE),stable)
1192   announcement_Cc_ ?= $(translation_project_), $(PACKAGE_BUGREPORT)
1193   announcement_mail_headers_ ?=                                         \
1194     To: info-gnu@gnu.org                                                \
1195     Cc: $(announcement_Cc_)                                             \
1196     Mail-Followup-To: $(PACKAGE_BUGREPORT)
1197 else
1198   announcement_Cc_ ?= $(translation_project_)
1199   announcement_mail_headers_ ?=                                         \
1200     To: $(PACKAGE_BUGREPORT)                                            \
1201     Cc: $(announcement_Cc_)
1202 endif
1203
1204 announcement: NEWS ChangeLog $(rel-files)
1205         @$(build_aux)/announce-gen                                      \
1206             --mail-headers='$(announcement_mail_headers_)'              \
1207             --release-type=$(RELEASE_TYPE)                              \
1208             --package=$(PACKAGE)                                        \
1209             --prev=$(PREV_VERSION)                                      \
1210             --curr=$(VERSION)                                           \
1211             --gpg-key-id=$(gpg_key_ID)                                  \
1212             --news=$(srcdir)/NEWS                                       \
1213             --bootstrap-tools=$(bootstrap-tools)                        \
1214             --gnulib-version=$(gnulib-version)                          \
1215             --no-print-checksums                                        \
1216             $(addprefix --url-dir=, $(url_dir_list))
1217
1218 ## ---------------- ##
1219 ## Updating files.  ##
1220 ## ---------------- ##
1221
1222 ftp-gnu = ftp://ftp.gnu.org/gnu
1223 www-gnu = http://www.gnu.org
1224
1225 upload_dest_dir_ ?= $(PACKAGE)
1226 emit_upload_commands:
1227         @echo =====================================
1228         @echo =====================================
1229         @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
1230         @echo "    --to $(gnu_rel_host):$(upload_dest_dir_) \\"
1231         @echo "  $(rel-files)"
1232         @echo '# send the ~/announce-$(my_distdir) e-mail'
1233         @echo =====================================
1234         @echo =====================================
1235
1236 define emit-commit-log
1237   printf '%s\n' 'post-release administrivia' '' \
1238     '* NEWS: Add header line for next release.' \
1239     '* .prev-version: Record previous version.' \
1240     '* cfg.mk (old_NEWS_hash): Auto-update.'
1241 endef
1242
1243 .PHONY: no-submodule-changes
1244 no-submodule-changes:
1245         if test -d $(srcdir)/.git; then                                 \
1246           diff=$$(cd $(srcdir) && git submodule -q foreach              \
1247                   git diff-index --name-only HEAD)                      \
1248             || exit 1;                                                  \
1249           case $$diff in '') ;;                                         \
1250             *) echo '$(ME): submodule files are locally modified:';     \
1251                 echo "$$diff"; exit 1;; esac;                           \
1252         else                                                            \
1253           : ;                                                           \
1254         fi
1255
1256 submodule-checks ?= no-submodule-changes public-submodule-commit
1257
1258 # Ensure that each sub-module commit we're using is public.
1259 # Without this, it is too easy to tag and release code that
1260 # cannot be built from a fresh clone.
1261 .PHONY: public-submodule-commit
1262 public-submodule-commit:
1263         $(AM_V_GEN)if test -d $(srcdir)/.git; then                      \
1264           cd $(srcdir) &&                                               \
1265           git submodule --quiet foreach test '$$(git rev-parse $$sha1)' \
1266               = '$$(git merge-base origin $$sha1)'                      \
1267             || { echo '$(ME): found non-public submodule commit' >&2;   \
1268                  exit 1; };                                             \
1269         else                                                            \
1270           : ;                                                           \
1271         fi
1272 # This rule has a high enough utility/cost ratio that it should be a
1273 # dependent of "check" by default.  However, some of us do occasionally
1274 # commit a temporary change that deliberately points to a non-public
1275 # submodule commit, and want to be able to use rules like "make check".
1276 # In that case, run e.g., "make check gl_public_submodule_commit="
1277 # to disable this test.
1278 gl_public_submodule_commit ?= public-submodule-commit
1279 check: $(gl_public_submodule_commit)
1280
1281 .PHONY: alpha beta stable
1282 ALL_RECURSIVE_TARGETS += alpha beta stable
1283 alpha beta stable: $(local-check) writable-files $(submodule-checks)
1284         test $@ = stable                                                \
1285           && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$'         \
1286                || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
1287           || :
1288         $(MAKE) vc-diff-check
1289         $(MAKE) news-check
1290         $(MAKE) distcheck
1291         $(MAKE) dist XZ_OPT=-9ev
1292         $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
1293         $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
1294
1295 # Override this in cfg.mk if you follow different procedures.
1296 release-prep-hook ?= release-prep
1297
1298 gl_noteworthy_news_ = * Noteworthy changes in release ?.? (????-??-??) [?]
1299 .PHONY: release-prep
1300 release-prep:
1301         case $$RELEASE_TYPE in alpha|beta|stable) ;; \
1302           *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
1303         $(MAKE) --no-print-directory -s announcement > ~/announce-$(my_distdir)
1304         if test -d $(release_archive_dir); then                 \
1305           ln $(rel-files) $(release_archive_dir);               \
1306           chmod a-w $(rel-files);                               \
1307         fi
1308         echo $(VERSION) > $(prev_version_file)
1309         $(MAKE) update-NEWS-hash
1310         perl -pi -e '$$. == 3 and print "$(gl_noteworthy_news_)\n\n\n"' NEWS
1311         $(emit-commit-log) > .ci-msg
1312         $(VC) commit -F .ci-msg -a
1313         rm .ci-msg
1314
1315 # Override this with e.g., -s $(srcdir)/some_other_name.texi
1316 # if the default $(PACKAGE)-derived name doesn't apply.
1317 gendocs_options_ ?=
1318
1319 .PHONY: web-manual
1320 web-manual:
1321         @test -z "$(manual_title)" \
1322           && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
1323         @cd '$(srcdir)/doc'; \
1324           $(SHELL) ../build-aux/gendocs.sh $(gendocs_options_) \
1325              -o '$(abs_builddir)/doc/manual' \
1326              --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
1327             "$(PACKAGE_NAME) - $(manual_title)"
1328         @echo " *** Upload the doc/manual directory to web-cvs."
1329
1330 # Code Coverage
1331
1332 init-coverage:
1333         $(MAKE) $(AM_MAKEFLAGS) clean
1334         lcov --directory . --zerocounters
1335
1336 COVERAGE_CCOPTS ?= "-g --coverage"
1337 COVERAGE_OUT ?= doc/coverage
1338
1339 build-coverage:
1340         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
1341         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
1342         mkdir -p $(COVERAGE_OUT)
1343         lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
1344                 --capture
1345
1346 gen-coverage:
1347         genhtml --output-directory $(COVERAGE_OUT) \
1348                 $(COVERAGE_OUT)/$(PACKAGE).info \
1349                 --highlight --frames --legend \
1350                 --title "$(PACKAGE_NAME)"
1351
1352 coverage: init-coverage build-coverage gen-coverage
1353
1354 # Update gettext files.
1355 PACKAGE ?= $(shell basename $(PWD))
1356 PO_DOMAIN ?= $(PACKAGE)
1357 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
1358 PODIR ?= po
1359 refresh-po:
1360         rm -f $(PODIR)/*.po && \
1361         echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
1362         wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
1363         echo 'en@boldquot' > $(PODIR)/LINGUAS && \
1364         echo 'en@quot' >> $(PODIR)/LINGUAS && \
1365         ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
1366
1367  # Running indent once is not idempotent, but running it twice is.
1368 INDENT_SOURCES ?= $(C_SOURCES)
1369 .PHONY: indent
1370 indent:
1371         indent $(INDENT_SOURCES)
1372         indent $(INDENT_SOURCES)
1373
1374 # If you want to set UPDATE_COPYRIGHT_* environment variables,
1375 # put the assignments in this variable.
1376 update-copyright-env ?=
1377
1378 # Run this rule once per year (usually early in January)
1379 # to update all FSF copyright year lists in your project.
1380 # If you have an additional project-specific rule,
1381 # add it in cfg.mk along with a line 'update-copyright: prereq'.
1382 # By default, exclude all variants of COPYING; you can also
1383 # add exemptions (such as ChangeLog..* for rotated change logs)
1384 # in the file .x-update-copyright.
1385 .PHONY: update-copyright
1386 update-copyright:
1387         grep -l -w Copyright                                             \
1388           $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
1389           | $(update-copyright-env) xargs $(build_aux)/$@
1390
1391 # This tight_scope test is skipped with a warning if $(_gl_TS_headers) is not
1392 # overridden and $(_gl_TS_dir)/Makefile.am does not mention noinst_HEADERS.
1393
1394 # NOTE: to override any _gl_TS_* default value, you must
1395 # define the variable(s) using "export" in cfg.mk.
1396 _gl_TS_dir ?= src
1397
1398 ALL_RECURSIVE_TARGETS += sc_tight_scope
1399 sc_tight_scope: tight-scope.mk
1400         @if ! grep '^ *export _gl_TS_headers *=' $(srcdir)/cfg.mk       \
1401                 > /dev/null                                             \
1402            && ! grep -w noinst_HEADERS $(srcdir)/$(_gl_TS_dir)/Makefile.am \
1403                 > /dev/null 2>&1; then                                  \
1404             echo '$(ME): skipping $@';                                  \
1405         else                                                            \
1406             $(MAKE) -s -C $(_gl_TS_dir)                                 \
1407                 -f Makefile                                             \
1408                 -f $(abs_top_srcdir)/cfg.mk                             \
1409                 -f $(abs_top_builddir)/$<                               \
1410               _gl_tight_scope                                           \
1411                 || fail=1;                                              \
1412         fi
1413         @rm -f $<
1414
1415 tight-scope.mk: $(ME)
1416         @rm -f $@ $@-t
1417         @perl -ne '/^# TS-start/.../^# TS-end/ and print' $(ME) > $@-t
1418         @chmod a=r $@-t && mv $@-t $@
1419
1420 ifeq (a,b)
1421 # TS-start
1422
1423 # Most functions should have static scope.
1424 # Any that don't must be marked with `extern', but `main'
1425 # and `usage' are exceptions: they're always extern, but
1426 # do not need to be marked.  Symbols matching `__.*' are
1427 # reserved by the compiler, so are automatically excluded below.
1428 _gl_TS_unmarked_extern_functions ?= main usage
1429 _gl_TS_function_match ?= /^(?:$(_gl_TS_extern)) +.*?(\S+) +\(/
1430
1431 # If your project uses a macro like "XTERN", then put
1432 # the following in cfg.mk to override this default:
1433 # export _gl_TS_extern = extern|XTERN
1434 _gl_TS_extern ?= extern
1435
1436 # The second nm|grep checks for file-scope variables with `extern' scope.
1437 # Without gnulib's progname module, you might put program_name here.
1438 # Symbols matching `__.*' are reserved by the compiler,
1439 # so are automatically excluded below.
1440 _gl_TS_unmarked_extern_vars ?=
1441
1442 # NOTE: the _match variables are perl expressions -- not mere regular
1443 # expressions -- so that you can extend them to match other patterns
1444 # and easily extract matched variable names.
1445 # For example, if your project declares some global variables via
1446 # a macro like this: GLOBAL(type, var_name, initializer), then you
1447 # can override this definition to automatically extract those names:
1448 # export _gl_TS_var_match = \
1449 #   /^(?:$(_gl_TS_extern)) .*?\**(\w+)(\[.*?\])?;/ || /\bGLOBAL\(.*?,\s*(.*?),/
1450 _gl_TS_var_match ?= /^(?:$(_gl_TS_extern)) .*?(\w+)(\[.*?\])?;/
1451
1452 # The names of object files in (or relative to) $(_gl_TS_dir).
1453 _gl_TS_obj_files ?= *.$(OBJEXT)
1454
1455 # Files in which to search for the one-line style extern declarations.
1456 # $(_gl_TS_dir)-relative.
1457 _gl_TS_headers ?= $(noinst_HEADERS)
1458
1459 .PHONY: _gl_tight_scope
1460 _gl_tight_scope: $(bin_PROGRAMS)
1461         t=exceptions-$$$$;                                              \
1462         trap 's=$$?; rm -f $$t; exit $$s' 0;                            \
1463         for sig in 1 2 3 13 15; do                                      \
1464           eval "trap 'v=`expr $$sig + 128`; (exit $$v); exit $$v' $$sig"; \
1465         done;                                                           \
1466         src=`for f in $(SOURCES); do                                    \
1467                test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`;   \
1468         hdr=`for f in $(_gl_TS_headers); do                             \
1469                test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`;   \
1470         ( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_functions);  \
1471           grep -h -A1 '^extern .*[^;]$$' $$src                          \
1472             | grep -vE '^(extern |--)' | sed 's/ .*//';                 \
1473           perl -lne                                                     \
1474              '$(_gl_TS_function_match) and print "^$$1\$$"' $$hdr;      \
1475         ) | sort -u > $$t;                                              \
1476         nm -e $(_gl_TS_obj_files) | sed -n 's/.* T //p'|grep -Ev -f $$t \
1477           && { echo the above functions should have static scope >&2;   \
1478                exit 1; } || : ;                                         \
1479         ( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_vars);       \
1480           perl -lne '$(_gl_TS_var_match) and print "^$$1\$$"' $$hdr *.h \
1481         ) | sort -u > $$t;                                              \
1482         nm -e $(_gl_TS_obj_files) | sed -n 's/.* [BCDGRS] //p'          \
1483             | sort -u | grep -Ev -f $$t                                 \
1484           && { echo the above variables should have static scope >&2;   \
1485                exit 1; } || :
1486 # TS-end
1487 endif