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