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