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-2009 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 # cfg.mk must define the gpg_key_ID used by this package.
  34 GIT = git
  35 VC = $(GIT)
  36 VC-tag = git tag -s -m '$(VERSION)' -u '$(gpg_key_ID)'
  37
  38 VC_LIST = $(build_aux)/vc-list-files -C $(srcdir)
  39
  40 VC_LIST_EXCEPT = \
  41   $(VC_LIST) | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
  42                else grep -Ev "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi
  43
  44 ifeq ($(origin prev_version_file), undefined)
  45   prev_version_file = $(srcdir)/.prev-version
  46 endif
  47
  48 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
  49 VERSION_REGEXP = $(subst .,\.,$(VERSION))
  50 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
  51
  52 ifeq ($(VC),$(GIT))
  53 this-vc-tag = v$(VERSION)
  54 this-vc-tag-regexp = v$(VERSION_REGEXP)
  55 else
  56 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
  57 tag-this-version = $(subst .,_,$(VERSION))
  58 this-vc-tag = $(tag-package)-$(tag-this-version)
  59 this-vc-tag-regexp = $(this-vc-tag)
  60 endif
  61 my_distdir = $(PACKAGE)-$(VERSION)
  62
  63 # Old releases are stored here.
  64 release_archive_dir ?= ../release
  65
  66 # Prevent programs like 'sort' from considering distinct strings to be equal.
  67 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
  68 export LC_ALL = C
  69
  70 ## --------------- ##
  71 ## Sanity checks.  ##
  72 ## --------------- ##
  73
  74 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
  75
  76 # Collect the names of rules starting with `sc_'.
  77 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
  78                         $(srcdir)/$(ME) $(_cfg_mk)))
  79 .PHONY: $(syntax-check-rules)
  80
  81 local-checks-available = \
  82   $(syntax-check-rules)
  83 .PHONY: $(local-checks-available)
  84
  85 # Arrange to print the name of each syntax-checking rule just before running it.
  86 $(syntax-check-rules): %: %.m
  87 $(patsubst %, %.m, $(syntax-check-rules)):
  88         @echo $(patsubst sc_%.m, %, $@)
  89
  90 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
  91
  92 syntax-check: $(local-check)
  93 #       @grep -nE '#  *include <(limits|std(def|arg|bool))\.h>'         \
  94 #           $$(find -type f -name '*.[chly]') &&                        \
  95 #         { echo '$(ME): found conditional include' 1>&2;               \
  96 #           exit 1; } || :
  97
  98 #       grep -nE '^#  *include <(string|stdlib)\.h>'                    \
  99 #           $(srcdir)/{lib,src}/*.[chy] &&                              \
 100 #         { echo '$(ME): FIXME' 1>&2;                                   \
 101 #           exit 1; } || :
 102 # FIXME: don't allow `#include .strings\.h' anywhere
 103
 104 # By default, _prohibit_regexp does not ignore case.
 105 export ignore_case =
 106 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
 107
 108 # There are many rules below that prohibit constructs in this package.
 109 # If the offending construct can be matched with a grep-E-style regexp,
 110 # use this macro.  The shell variables "re" and "msg" must be defined.
 111 define _prohibit_regexp
 112   dummy=; : so we do not need a semicolon before each use;              \
 113   test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; };  \
 114   test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
 115   grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) &&              \
 116     { echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
 117 endef
 118
 119 sc_avoid_if_before_free:
 120         @$(build_aux)/useless-if-before-free                            \
 121                 $(useless_free_options)                                 \
 122             $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) &&   \
 123           { echo '$(ME): found useless "if" before "free" above' 1>&2;  \
 124             exit 1; } || :
 125
 126 sc_cast_of_argument_to_free:
 127         @re='\<free *\( *\(' msg='don'\''t cast free argument'          \
 128           $(_prohibit_regexp)
 129
 130 sc_cast_of_x_alloc_return_value:
 131         @re='\*\) *x(m|c|re)alloc\>'                                    \
 132         msg='don'\''t cast x*alloc return value'                        \
 133           $(_prohibit_regexp)
 134
 135 sc_cast_of_alloca_return_value:
 136         @re='\*\) *alloca\>' msg='don'\''t cast alloca return value'    \
 137           $(_prohibit_regexp)
 138
 139 sc_space_tab:
 140         @re='[ ]        ' msg='found SPACE-TAB sequence; remove the SPACE' \
 141           $(_prohibit_regexp)
 142
 143 # Don't use *scanf or the old ato* functions in `real' code.
 144 # They provide no error checking mechanism.
 145 # Instead, use strto* functions.
 146 sc_prohibit_atoi_atof:
 147         @re='\<([fs]?scanf|ato([filq]|ll)) *\('                         \
 148         msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
 149           $(_prohibit_regexp)
 150
 151 # Use STREQ rather than comparing strcmp == 0, or != 0.
 152 sc_prohibit_strcmp:
 153         @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *=='           \
 154             $$($(VC_LIST_EXCEPT))                                       \
 155           | grep -vE ':# *define STREQ\(' &&                            \
 156           { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
 157                 1>&2; exit 1; } || :
 158
 159 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
 160 sc_prohibit_magic_number_exit:
 161         @re='\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,'           \
 162         msg='use EXIT_* values rather than magic number'                \
 163           $(_prohibit_regexp)
 164
 165 # Using EXIT_SUCCESS as the first argument to error is misleading,
 166 # since when that parameter is 0, error does not exit.  Use `0' instead.
 167 sc_error_exit_success:
 168         @grep -nE 'error \(EXIT_SUCCESS,'                               \
 169             $$($(VC_LIST_EXCEPT) | grep -E '\.[chly]$$') &&             \
 170           { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; exit 1; } || :
 171
 172 # `FATAL:' should be fully upper-cased in error messages
 173 # `WARNING:' should be fully upper-cased, or fully lower-cased
 174 sc_error_message_warn_fatal:
 175         @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT))               \
 176             | grep -E '"Warning|"Fatal|"fatal' &&                       \
 177           { echo '$(ME): use FATAL, WARNING or warning' 1>&2;           \
 178             exit 1; } || :
 179
 180 # Error messages should not start with a capital letter
 181 sc_error_message_uppercase:
 182         @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT))               \
 183             | grep -E '"[A-Z]'                                          \
 184             | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' &&           \
 185           { echo '$(ME): found capitalized error message' 1>&2;         \
 186             exit 1; } || :
 187
 188 # Error messages should not end with a period
 189 sc_error_message_period:
 190         @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT))               \
 191             | grep -E '[^."]\."' &&                                     \
 192           { echo '$(ME): found error message ending in period' 1>&2;    \
 193             exit 1; } || :
 194
 195 sc_file_system:
 196         @re=file''system ignore_case=1                                  \
 197         msg='found use of "file''system"; spell it "file system"'       \
 198           $(_prohibit_regexp)
 199
 200 # Don't use cpp tests of this symbol.  All code assumes config.h is included.
 201 sc_prohibit_have_config_h:
 202         @grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) &&     \
 203           { echo '$(ME): found use of HAVE''_CONFIG_H; remove'          \
 204                 1>&2; exit 1; } || :
 205
 206 # Nearly all .c files must include <config.h>.  However, we also permit this
 207 # via inclusion of a package-specific header, if cfg.mk specified one.
 208 # config_h_header must be suitable for grep -E.
 209 config_h_header ?= <config\.h>
 210 sc_require_config_h:
 211         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
 212           grep -EL '^# *include $(config_h_header)'                     \
 213                 $$($(VC_LIST_EXCEPT) | grep '\.c$$')                    \
 214               | grep . &&                                               \
 215           { echo '$(ME): the above files do not include <config.h>'     \
 216                 1>&2; exit 1; } || :;                                   \
 217         else :;                                                         \
 218         fi
 219
 220 # You must include <config.h> before including any other header file.
 221 # This can possibly be via a package-specific header, if given by cfg.mk.
 222 sc_require_config_h_first:
 223         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
 224           fail=0;                                                       \
 225           for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do             \
 226             grep '^# *include\>' $$i | sed 1q                           \
 227                 | grep -E '^# *include $(config_h_header)' > /dev/null  \
 228               || { echo $$i; fail=1; };                                 \
 229           done;                                                         \
 230           test $$fail = 1 &&                                            \
 231             { echo '$(ME): the above files include some other header'   \
 232                 'before <config.h>' 1>&2; exit 1; } || :;               \
 233         else :;                                                         \
 234         fi
 235
 236 sc_prohibit_HAVE_MBRTOWC:
 237         @re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
 238           $(_prohibit_regexp)
 239
 240 # To use this "command" macro, you must first define two shell variables:
 241 # h: the header, enclosed in <> or ""
 242 # re: a regular expression that matches IFF something provided by $h is used.
 243 define _header_without_use
 244   dummy=; : so we do not need a semicolon before each use;              \
 245   h_esc=`echo "$$h"|sed 's/\./\\\\./g'`;                                \
 246   if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then              \
 247     files=$$(grep -l '^# *include '"$$h_esc"                            \
 248              $$($(VC_LIST_EXCEPT) | grep '\.c$$')) &&                   \
 249     grep -LE "$$re" $$files | grep . &&                                 \
 250       { echo "$(ME): the above files include $$h but don't use it"      \
 251         1>&2; exit 1; } || :;                                           \
 252   else :;                                                               \
 253   fi
 254 endef
 255
 256 # Prohibit the inclusion of assert.h without an actual use of assert.
 257 sc_prohibit_assert_without_use:
 258         @h='<assert.h>' re='\<assert *\(' $(_header_without_use)
 259
 260 # Prohibit the inclusion of close-stream.h without an actual use.
 261 sc_prohibit_close_stream_without_use:
 262         @h='"close-stream.h"' re='\<close_stream *\(' $(_header_without_use)
 263
 264 # Prohibit the inclusion of getopt.h without an actual use.
 265 sc_prohibit_getopt_without_use:
 266         @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
 267
 268 # Don't include quotearg.h unless you use one of its functions.
 269 sc_prohibit_quotearg_without_use:
 270         @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
 271
 272 # Don't include quote.h unless you use one of its functions.
 273 sc_prohibit_quote_without_use:
 274         @h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
 275
 276 # Don't include this header unless you use one of its functions.
 277 sc_prohibit_long_options_without_use:
 278         @h='"long-options.h"' re='\<parse_long_options *\(' \
 279           $(_header_without_use)
 280
 281 # Don't include this header unless you use one of its functions.
 282 sc_prohibit_inttostr_without_use:
 283         @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
 284           $(_header_without_use)
 285
 286 # Don't include this header unless you use one of its functions.
 287 sc_prohibit_error_without_use:
 288         @h='"error.h"' \
 289         re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
 290           $(_header_without_use)
 291
 292 # Don't include xalloc.h unless you use one of its functions.
 293 # Consider these symbols:
 294 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
 295 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) \(/ and print $1' lib/xalloc.h
 296 # Divide into two sets on case, and filter each through this:
 297 # | sort | perl -MRegexp::Assemble -le \
 298 #  'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
 299 # Note this was produced by the above:
 300 # _xa1 = x(alloc_(oversized|die)|([cz]|2?re)alloc|m(alloc|emdup)|strdup)
 301 # But we can do better:
 302 _xa1 = x(alloc_(oversized|die)|([cmz]|2?re)alloc|(mem|str)dup)
 303 _xa2 = X([CZ]|N?M)ALLOC
 304 sc_prohibit_xalloc_without_use:
 305         @h='"xalloc.h"' \
 306         re='\<($(_xa1)|$(_xa2)) *\('\
 307           $(_header_without_use)
 308
 309 sc_prohibit_safe_read_without_use:
 310         @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
 311           $(_header_without_use)
 312
 313 sc_prohibit_argmatch_without_use:
 314         @h='"argmatch.h"' \
 315         re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
 316           $(_header_without_use)
 317
 318 sc_prohibit_canonicalize_without_use:
 319         @h='"canonicalize.h"' \
 320         re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
 321           $(_header_without_use)
 322
 323 sc_prohibit_root_dev_ino_without_use:
 324         @h='"root-dev-ino.h"' \
 325         re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
 326           $(_header_without_use)
 327
 328 sc_prohibit_openat_without_use:
 329         @h='"openat.h"' \
 330         re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
 331           $(_header_without_use)
 332
 333 # Prohibit the inclusion of c-ctype.h without an actual use.
 334 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
 335 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
 336 sc_prohibit_c_ctype_without_use:
 337         @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
 338
 339 _empty =
 340 _sp = $(_empty) $(_empty)
 341 # The following list was generated by running:
 342 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
 343 #   | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
 344 _sig_functions = \
 345   bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
 346   sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
 347   siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
 348   sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
 349 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
 350 # The following were extracted from "man signal.h" manually.
 351 _sig_types_and_consts =                                                 \
 352   MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK           \
 353   SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL            \
 354   SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE    \
 355   SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t  \
 356   sigstack sigval stack_t ucontext_t
 357 # generated via this:
 358 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
 359 _sig_names =                                                            \
 360   SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT      \
 361   SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL       \
 362   SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP  \
 363   SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR      \
 364   SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS   \
 365   SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1        \
 366   SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW       \
 367   SIGXCPU SIGXFSZ
 368 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
 369
 370 # Prohibit the inclusion of signal.h without an actual use.
 371 sc_prohibit_signal_without_use:
 372         @h='<signal.h>'                                                 \
 373         re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>'          \
 374           $(_header_without_use)
 375
 376 sc_obsolete_symbols:
 377         @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>'                           \
 378         msg='do not use HAVE''_FCNTL_H or O'_NDELAY                     \
 379           $(_prohibit_regexp)
 380
 381 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
 382
 383 # Each nonempty ChangeLog line must start with a year number, or a TAB.
 384 sc_changelog:
 385         @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
 386           grep -n '^[^12        ]'                                      \
 387             $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') &&              \
 388           { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2;  \
 389             exit 1; } || :;                                             \
 390         fi
 391
 392 # Ensure that each .c file containing a "main" function also
 393 # calls set_program_name.
 394 sc_program_name:
 395         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
 396           files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
 397           grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files         \
 398               | grep . &&                                               \
 399           { echo '$(ME): the above files do not call set_program_name'  \
 400                 1>&2; exit 1; } || :;                                   \
 401         else :;                                                         \
 402         fi
 403
 404 # Require that the final line of each test-lib.sh-using test be this one:
 405 # Exit $fail
 406 # Note: this test requires GNU grep's --label= option.
 407 Exit_witness_file ?= tests/test-lib.sh
 408 Exit_base := $(notdir $(Exit_witness_file))
 409 sc_require_test_exit_idiom:
 410         @if test -f $(srcdir)/$(Exit_witness_file); then                \
 411           die=0;                                                        \
 412           for i in $$(grep -l -F 'srcdir/$(Exit_base)'                  \
 413                 $$($(VC_LIST) tests)); do                               \
 414             tail -n1 $$i | grep '^Exit .' > /dev/null                   \
 415               && : || { die=1; echo $$i; }                              \
 416           done;                                                         \
 417           test $$die = 1 &&                                             \
 418             { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
 419               echo 1>&2 'Exit something';                               \
 420               exit 1; } || :;                                           \
 421         fi
 422
 423 sc_the_the:
 424         @re='\<the ''the\>'                                             \
 425         ignore_case=1 msg='found use of "the ''the";'                   \
 426           $(_prohibit_regexp)
 427
 428 sc_trailing_blank:
 429         @re='[   ]$$'                                                   \
 430         msg='found trailing blank(s)'                                   \
 431           $(_prohibit_regexp)
 432
 433 # Match lines like the following, but where there is only one space
 434 # between the options and the description:
 435 #   -D, --all-repeated[=delimit-method]  print all duplicate lines\n
 436 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
 437 sc_two_space_separator_in_usage:
 438         @grep -nE '^   *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$'         \
 439             $$($(VC_LIST_EXCEPT)) &&                                    \
 440           { echo "$(ME): help2man requires at least two spaces between"; \
 441             echo "$(ME): an option and its description";                \
 442                 1>&2; exit 1; } || :
 443
 444 # Look for diagnostics that aren't marked for translation.
 445 # This won't find any for which error's format string is on a separate line.
 446 sc_unmarked_diagnostics:
 447         @grep -nE                                                       \
 448             '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT))       \
 449           | grep -v '_''(' &&                                           \
 450           { echo '$(ME): found unmarked diagnostic(s)' 1>&2;            \
 451             exit 1; } || :
 452
 453 # Avoid useless parentheses like those in this example:
 454 # #if defined (SYMBOL) || defined (SYM2)
 455 sc_useless_cpp_parens:
 456         @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) &&         \
 457           { echo '$(ME): found useless parentheses in cpp directive'    \
 458                 1>&2; exit 1; } || :
 459
 460 # Require the latest GPL.
 461 sc_GPL_version:
 462         @re='either ''version [^3]' msg='GPL vN, N!=3'                  \
 463           $(_prohibit_regexp)
 464
 465 cvs_keywords = \
 466   Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
 467
 468 sc_prohibit_cvs_keyword:
 469         @re='\$$($(cvs_keywords))\$$'                                   \
 470             msg='do not use CVS keyword expansion'                      \
 471           $(_prohibit_regexp)
 472
 473 # Make sure we don't use st_blocks.  Use ST_NBLOCKS instead.
 474 # This is a bit of a kludge, since it prevents use of the string
 475 # even in comments, but for now it does the job with no false positives.
 476 sc_prohibit_stat_st_blocks:
 477         @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS'  \
 478           $(_prohibit_regexp)
 479
 480 # Make sure we don't define any S_IS* macros in src/*.c files.
 481 # They're already defined via gnulib's sys/stat.h replacement.
 482 sc_prohibit_S_IS_definition:
 483         @re='^ *# *define  *S_IS'                                       \
 484         msg='do not define S_IS* macros; include <sys/stat.h>'          \
 485           $(_prohibit_regexp)
 486
 487 # Each program that uses proper_name_utf8 must link with
 488 # one of the ICONV libraries.
 489 sc_proper_name_utf8_requires_ICONV:
 490         @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
 491         if test "x$$progs" != x; then                                   \
 492           fail=0;                                                       \
 493           for p in $$progs; do                                          \
 494             dir=$$(dirname "$$p");                                      \
 495             base=$$(basename "$$p" .c);                                 \
 496             grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
 497               || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
 498           done;                                                         \
 499           test $$fail = 1 &&                                            \
 500             { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
 501               exit 1; } || :;                                           \
 502         fi
 503
 504 # Warn about "c0nst struct Foo const foo[]",
 505 # but not about "char const *const foo" or "#define const const".
 506 sc_redundant_const:
 507         @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b'                \
 508         msg='redundant "const" in declarations'                         \
 509           $(_prohibit_regexp)
 510
 511 sc_const_long_option:
 512         @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT))         \
 513           | grep -Ev 'const struct option|struct option const' && {     \
 514               echo 1>&2 '$(ME): add "const" to the above declarations'; \
 515               exit 1; } || :
 516
 517 NEWS_hash =                                                             \
 518   $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p'              \
 519        $(srcdir)/NEWS                                                   \
 520      | grep -v '^Copyright .*Free Software'                             \
 521      | md5sum -                                                         \
 522      | sed 's/ .*//')
 523
 524 # Ensure that we don't accidentally insert an entry into an old NEWS block.
 525 sc_immutable_NEWS:
 526         @if test -f $(srcdir)/NEWS; then                                \
 527           test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : ||              \
 528             { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
 529         fi
 530
 531 # Update the hash stored above.  Do this after each release and
 532 # for any corrections to old entries.
 533 update-NEWS-hash: NEWS
 534         perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
 535           $(srcdir)/cfg.mk
 536
 537 # Ensure that we use only the standard $(VAR) notation,
 538 # not @...@ in Makefile.am, now that we can rely on automake
 539 # to emit a definition for each substituted variable.
 540 # We use perl rather than "grep -nE ..." to exempt a single
 541 # use of an @...@-delimited variable name in src/Makefile.am.
 542 sc_makefile_check:
 543         @perl -ne '/\@[A-Z_0-9]+\@/ && !/^cu_install_program =/'        \
 544           -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}'    \
 545             $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$')       \
 546           && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
 547
 548 news-date-check: NEWS
 549         today=`date +%Y-%m-%d`;                                         \
 550         if head $(srcdir)/NEWS | grep '^\*.* $(VERSION_REGEXP) ('$$today')' \
 551             >/dev/null; then                                            \
 552           :;                                                            \
 553         else                                                            \
 554           echo "version or today's date is not in NEWS" 1>&2;           \
 555           exit 1;                                                       \
 556         fi
 557
 558 sc_makefile_TAB_only_indentation:
 559         @grep -nE '^    [ ]{8}'                                         \
 560             $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$')            \
 561           && { echo '$(ME): found TAB-8-space indentation' 1>&2;        \
 562                exit 1; } || :
 563
 564 sc_m4_quote_check:
 565         @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]'              \
 566             $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$')   \
 567           && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2;       \
 568                exit 1; } || :
 569
 570 fix_po_file_diag = \
 571 'you have changed the set of files with translatable diagnostics;\n\
 572 apply the above patch\n'
 573
 574 # Verify that all source files using _() are listed in po/POTFILES.in.
 575 po_file = po/POTFILES.in
 576 sc_po_check:
 577         @if test -f $(po_file); then                                    \
 578           grep -E -v '^(#|$$)' $(po_file)                               \
 579             | grep -v '^src/false\.c$$' | sort > $@-1;                  \
 580           files=;                                                       \
 581           for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do              \
 582             test -r $$file || continue;                                 \
 583             case $$file in                                              \
 584               *.m4|*.mk) continue ;;                                    \
 585               *.?|*.??) ;;                                              \
 586               *) continue;;                                             \
 587             esac;                                                       \
 588             case $$file in                                              \
 589             *.[ch])                                                     \
 590               base=`expr " $$file" : ' \(.*\)\..'`;                     \
 591               { test -f $$base.l || test -f $$base.y; } && continue;;   \
 592             esac;                                                       \
 593             files="$$files $$file";                                     \
 594           done;                                                         \
 595           grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files          \
 596             | sort -u > $@-2;                                           \
 597           diff -u -L $(po_file) -L $(po_file) $@-1 $@-2                 \
 598             || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; };   \
 599           rm -f $@-1 $@-2;                                              \
 600         fi
 601
 602 # Sometimes it is useful to change the PATH environment variable
 603 # in Makefiles.  When doing so, it's better not to use the Unix-centric
 604 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
 605 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
 606 sc_makefile_path_separator_check:
 607         @grep -nE 'PATH[=].*:'                                          \
 608             $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$')            \
 609           && { echo $(msg) 1>&2; exit 1; } || :
 610
 611 # Check that `make alpha' will not fail at the end of the process.
 612 writable-files:
 613         if test -d $(release_archive_dir); then :; else                 \
 614           for file in $(distdir).tar.gz                                 \
 615                       $(release_archive_dir)/$(distdir).tar.gz; do      \
 616             test -e $$file || continue;                                 \
 617             test -w $$file                                              \
 618               || { echo ERROR: $$file is not writable; fail=1; };       \
 619           done;                                                         \
 620           test "$$fail" && exit 1 || : ;                                \
 621         fi
 622
 623 v_etc_file = lib/version-etc.c
 624 sample-test = tests/sample-test
 625 texi = doc/$(PACKAGE).texi
 626 # Make sure that the copyright date in $(v_etc_file) is up to date.
 627 # Do the same for the $(sample-test) and the main doc/.texi file.
 628 sc_copyright_check:
 629         @if test -f $(v_etc_file); then                                 \
 630           grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
 631             >/dev/null                                                  \
 632           || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
 633                exit 1; };                                               \
 634         fi
 635         @if test -f $(sample-test); then                                \
 636           grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test)     \
 637             >/dev/null                                                  \
 638           || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
 639                exit 1; };                                               \
 640         fi
 641         @if test -f $(texi); then                                       \
 642           grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi)   \
 643             >/dev/null                                                  \
 644           || { echo 'out of date copyright in $(texi); update it' 1>&2; \
 645                exit 1; };                                               \
 646         fi
 647
 648 vc-diff-check:
 649         (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
 650         if test -s vc-diffs; then                               \
 651           cat vc-diffs;                                         \
 652           echo "Some files are locally modified:" 1>&2;         \
 653           exit 1;                                               \
 654         else                                                    \
 655           rm vc-diffs;                                          \
 656         fi
 657
 658 # Use this to make sure we don't run these programs when building
 659 # from a virgin tgz file, below.
 660 null_AM_MAKEFLAGS = \
 661   ACLOCAL=false \
 662   AUTOCONF=false \
 663   AUTOMAKE=false \
 664   AUTOHEADER=false \
 665   MAKEINFO=false
 666
 667 built_programs = $$(cd src && MAKEFLAGS= $(MAKE) -s built_programs.list)
 668
 669 rel-files = $(DIST_ARCHIVES)
 670
 671 gnulib_dir ?= $(srcdir)/gnulib
 672 gnulib-version = $$(cd $(gnulib_dir) && git describe)
 673 bootstrap-tools ?= autoconf,automake,gnulib
 674
 675 announcement: NEWS ChangeLog $(rel-files)
 676         @$(build_aux)/announce-gen                                      \
 677             --release-type=$(RELEASE_TYPE)                              \
 678             --package=$(PACKAGE)                                        \
 679             --prev=$(PREV_VERSION)                                      \
 680             --curr=$(VERSION)                                           \
 681             --gpg-key-id=$(gpg_key_ID)                                  \
 682             --news=NEWS                                                 \
 683             --bootstrap-tools=$(bootstrap-tools)                        \
 684             --gnulib-version=$(gnulib-version)                          \
 685             --no-print-checksums                                        \
 686             $(addprefix --url-dir=, $(url_dir_list))
 687
 688 ## ---------------- ##
 689 ## Updating files.  ##
 690 ## ---------------- ##
 691
 692 ftp-gnu = ftp://ftp.gnu.org/gnu
 693 www-gnu = http://www.gnu.org
 694
 695 emit_upload_commands:
 696         @echo =====================================
 697         @echo =====================================
 698         @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
 699         @echo "    --to $(gnu_rel_host):$(PACKAGE) \\"
 700         @echo "  $(rel-files)"
 701         @echo '# send the /tmp/announcement e-mail'
 702         @echo =====================================
 703         @echo =====================================
 704
 705 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
 706 define emit-commit-log
 707   printf '%s\n' 'post-release administrivia' '' \
 708     '* NEWS: Add header line for next release.' \
 709     '* .prev-version: Record previous version.' \
 710     '* cfg.mk (old_NEWS_hash): Auto-update.'
 711 endef
 712
 713 .PHONY: no-submodule-changes
 714 no-submodule-changes:
 715         if test -d $(srcdir)/.git; then                                 \
 716           diff=$$(cd $(srcdir) && git submodule -q foreach              \
 717                   git diff-index --name-only HEAD)                      \
 718             || exit 1;                                                  \
 719           case $$diff in '') ;;                                         \
 720             *) echo '$(ME): submodule files are locally modified:';     \
 721                 echo "$$diff"; exit 1;; esac;                           \
 722         else                                                            \
 723           : ;                                                           \
 724         fi
 725
 726 .PHONY: alpha beta stable
 727 ALL_RECURSIVE_TARGETS += alpha beta stable
 728 alpha beta stable: $(local-check) writable-files no-submodule-changes
 729         test $@ = stable                                                \
 730           && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$'         \
 731                || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
 732           || :
 733         $(MAKE) vc-diff-check
 734         $(MAKE) news-date-check
 735         $(MAKE) distcheck
 736         $(MAKE) dist XZ_OPT=-9ev
 737         $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
 738         if test -d $(release_archive_dir); then                 \
 739           ln $(rel-files) $(release_archive_dir);               \
 740           chmod a-w $(rel-files);                               \
 741         fi
 742         $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
 743         echo $(VERSION) > $(prev_version_file)
 744         $(MAKE) update-NEWS-hash
 745         perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
 746         $(emit-commit-log) > .ci-msg
 747         $(VC) commit -F .ci-msg -a
 748
 749 .PHONY: web-manual
 750 web-manual:
 751         @test -z "$(manual_title)" \
 752           && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
 753         @cd '$(srcdir)/doc'; \
 754           $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
 755              --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
 756             "$(PACKAGE_NAME) - $(manual_title)"
 757         @echo " *** Upload the doc/manual directory to web-cvs."
 758
 759 # Code Coverage
 760
 761 init-coverage:
 762         $(MAKE) $(AM_MAKEFLAGS) clean
 763         lcov --directory . --zerocounters
 764
 765 COVERAGE_CCOPTS ?= "-g --coverage"
 766 COVERAGE_OUT ?= doc/coverage
 767
 768 build-coverage:
 769         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
 770         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
 771         mkdir -p $(COVERAGE_OUT)
 772         lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
 773                 --capture
 774
 775 gen-coverage:
 776         genhtml --output-directory $(COVERAGE_OUT) \
 777                 $(COVERAGE_OUT)/$(PACKAGE).info \
 778                 --highlight --frames --legend \
 779                 --title "$(PACKAGE_NAME)"
 780
 781 coverage: init-coverage build-coverage gen-coverage
 782
 783 # Update gettext files.
 784 PACKAGE ?= $(shell basename $(PWD))
 785 PO_DOMAIN ?= $(PACKAGE)
 786 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
 787 PODIR ?= po
 788 refresh-po:
 789         rm -f $(PODIR)/*.po && \
 790         echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
 791         wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
 792         echo 'en@boldquot' > $(PODIR)/LINGUAS && \
 793         echo 'en@quot' >> $(PODIR)/LINGUAS && \
 794         ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
 795
 796 INDENT_SOURCES ?= $(C_SOURCES)
 797 .PHONY: indent
 798 indent:
 799         indent $(INDENT_SOURCES)
 800
 801 # If you want to set UPDATE_COPYRIGHT_* environment variables,
 802 # put the assignments in this variable.
 803 update-copyright-env ?=
 804
 805 # Run this rule once per year (usually early in January)
 806 # to update all FSF copyright year lists in your project.
 807 # If you have an additional project-specific rule,
 808 # add it in cfg.mk along with a line 'update-copyright: prereq'.
 809 # By default, exclude all variants of COPYING; you can also
 810 # add exemptions (such as ChangeLog..* for rotated change logs)
 811 # in the file .x-update-copyright.
 812 .PHONY: update-copyright
 813 update-copyright:
 814         grep -l -w Copyright                                             \
 815           $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
 816           | $(update-copyright-env) xargs $(build_aux)/$@