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