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